altintegration::ReadStream Struct Reference

Binary reading stream, that is useful during binary deserialization. More...

Detailed Description

Definition at line 22 of file read_stream.hpp.

#include <read_stream.hpp>

Collaboration diagram for altintegration::ReadStream:

Public Member Functions
	ReadStream (const void *buff, size_t size)
	ReadStream (Slice< const uint8_t > slice)
	ReadStream (const std::vector< uint8_t > &v)
	ReadStream (const std::string &s)
	ReadStream (ReadStream &&)=default
ReadStream &	operator= (ReadStream &&)=default
bool	read (size_t size, uint8_t *out, ValidationState &state)
	Read type T of 'size' bytes. More...
std::vector< uint8_t >	assertRead (size_t size)
bool	readSlice (size_t size, Slice< const uint8_t > &out, ValidationState &state)
Slice< const uint8_t >	assertReadSlice (size_t size)
template<typename T , typename = typename std::enable_if<std::is_integral<T>::value>::type>
T	assertReadBE (size_t bytes=sizeof(T))
template<typename T , typename = typename std::enable_if<std::is_integral<T>::value>::type>
bool	readBE (T &t, ValidationState &state, size_t bytes=sizeof(T))
template<typename T , typename = typename std::enable_if<std::is_integral<T>::value>::type>
T	assertReadLE ()
template<typename T , typename = typename std::enable_if<std::is_integral<T>::value>::type>
bool	readLE (T &t, ValidationState &state)
uint32_t	getVersion () const noexcept
void	setVersion (uint32_t version) noexcept
size_t	position () const noexcept
void	setPosition (const size_t &) noexcept
size_t	remaining () const noexcept
bool	hasMore (size_t nbytes) const noexcept
void	reset () noexcept
Slice< const uint8_t >	data () const
Slice< const uint8_t >	remainingBytes () const

Member Function Documentation

assertReadBE()

template<typename T , typename = typename std::enable_if<std::is_integral<T>::value>::type>

T altintegration::ReadStream::assertReadBE ( size_t  bytes = sizeof(T) )

inline

Definition at line 56 of file read_stream.hpp.

                                           {
    ValidationState state;
    T t = 0;
    bool result = readBE<T>(t, state, bytes);
    VBK_ASSERT_MSG(result, "Can't readBE: %s", state.toString());
    return t;
  }

assertReadLE()

template<typename T , typename = typename std::enable_if<std::is_integral<T>::value>::type>

T altintegration::ReadStream::assertReadLE ( )

inline

Definition at line 86 of file read_stream.hpp.

                   {
    ValidationState state;
    T t = 0;
    bool result = readLE<T>(t, state);
    VBK_ASSERT_MSG(result, "Can't readLE: %s", state.toString());
    return t;
  }

hasMore()

bool altintegration::ReadStream::hasMore ( size_t  nbytes ) const

inlinenoexcept

Definition at line 119 of file read_stream.hpp.

{ return (remaining() >= nbytes); }

read()

bool altintegration::ReadStream::read	(	size_t	size,
		uint8_t *	out,
		ValidationState &	state
	)

Parameters

size	bytes to be read
out	preallocated array of at least size
state	will return error description here

Returns

true if read is OK, false otherwise

readBE()

template<typename T , typename = typename std::enable_if<std::is_integral<T>::value>::type>

bool altintegration::ReadStream::readBE ( T &  t, ValidationState &  state, size_t  bytes = sizeof(T)  )

inline

Definition at line 68 of file read_stream.hpp.

                                                                      {
    if (!hasMore(bytes)) {
      return state.Invalid(
          "readbe-underflow",
          format("Tried to read {} bytes from stream, but it has {} bytes",
                 bytes,
                 remaining()));
    }
    t = 0;
    for (size_t i = 0, shift = (bytes - 1) * 8; i < bytes; i++, shift -= 8) {
      t += static_cast<T>((static_cast<T>(m_Buffer[m_Pos++])) << shift);
    }
    return true;
  }

readLE()

template<typename T , typename = typename std::enable_if<std::is_integral<T>::value>::type>

bool altintegration::ReadStream::readLE ( T &  t, ValidationState &  state  )

inline

Definition at line 98 of file read_stream.hpp.

                                            {
    if (!hasMore(sizeof(T))) {
      return state.Invalid(
          "readle-underflow",
          format("Tried to read {} bytes from stream, but it has {} bytes",
                 sizeof(T),
                 remaining()));
    }
 
    t = 0;
    for (size_t i = 0, shift = 0; i < sizeof(T); i++, shift += 8) {
      t += static_cast<T>((static_cast<T>(m_Buffer[m_Pos++])) << shift);
    }
    return true;
  }

remaining()

size_t altintegration::ReadStream::remaining ( ) const

inlinenoexcept

Definition at line 118 of file read_stream.hpp.

{ return (m_Size - m_Pos); }

---

The documentation for this struct was generated from the following file:

• include/veriblock/pop/read_stream.hpp