EndianBufferReader Class Reference

Endian-aware buffer adapter that always reads values in little endian order. More...

#include <endian_buffer.hpp>

Public Member Functions
	EndianBufferReader (std::span< const uint8_t > buffer)
void	rewind ()
EndianBufferReader &	operator>> (std::string &data)
EndianBufferReader &	operator>> (EncodedString &data)
EndianBufferReader &	operator>> (bool &data)
template<typename... Targs>
EndianBufferReader &	operator>> (std::tuple< Targs... > &data)
template<typename... Targs>
EndianBufferReader &	operator>> (std::variant< Targs... > &variant)
EndianBufferReader &	operator>> (const std::monostate &)
template<ConvertibleThroughBase T>
EndianBufferReader &	operator>> (T &data)
template<class T>
EndianBufferReader &	operator>> (T &data)

Static Public Member Functions
template<typename Tvalue>
static Tvalue	ToValue (std::span< const uint8_t > buffer)

Private Member Functions
template<class Ttuple, size_t... Tindices>
void	ReadTuple (Ttuple &values, std::index_sequence< Tindices... >)
	Helper function to read a tuple from the buffer.
template<typename T, std::size_t I = 0>
void	ReadVariant (uint8_t index, T &variant)
std::string	ReadStr ()
	Read overload for string data.
template<class T>
T	Read ()
	Fundamental read function.

Private Attributes
std::span< const uint8_t >	buffer
	Reference to storage buffer.
size_t	read_pos = 0
	Current read position.

Detailed Description

Endian-aware buffer adapter that always reads values in little endian order.

Note

This class uses operator overloading (>>, just like streams) for reading as this allows providing custom operator overloads for more complex types like e.g. structs without needing to modify this class.

Definition at line 154 of file endian_buffer.hpp.

Constructor & Destructor Documentation

EndianBufferReader()

EndianBufferReader::EndianBufferReader ( std::span< const uint8_t > buffer )

inline

Definition at line 161 of file endian_buffer.hpp.

Member Function Documentation

operator>>() [1/8]

EndianBufferReader & EndianBufferReader::operator>> ( bool & data )

inline

Definition at line 167 of file endian_buffer.hpp.

operator>>() [2/8]

EndianBufferReader & EndianBufferReader::operator>> ( const std::monostate & )

inline

Definition at line 183 of file endian_buffer.hpp.

operator>>() [3/8]

EndianBufferReader & EndianBufferReader::operator>> ( EncodedString & data )

inline

Definition at line 166 of file endian_buffer.hpp.

operator>>() [4/8]

EndianBufferReader & EndianBufferReader::operator>> ( std::string & data )

inline

Definition at line 165 of file endian_buffer.hpp.

operator>>() [5/8]

template<typename... Targs>

EndianBufferReader & EndianBufferReader::operator>> ( std::tuple< Targs... > & data )

inline

Definition at line 170 of file endian_buffer.hpp.

operator>>() [6/8]

template<typename... Targs>

EndianBufferReader & EndianBufferReader::operator>> ( std::variant< Targs... > & variant )

inline

Definition at line 177 of file endian_buffer.hpp.

operator>>() [7/8]

template<class T>

EndianBufferReader & EndianBufferReader::operator>> ( T & data )

inline

Definition at line 196 of file endian_buffer.hpp.

operator>>() [8/8]

template<ConvertibleThroughBase T>

EndianBufferReader & EndianBufferReader::operator>> ( T & data )

inline

Definition at line 189 of file endian_buffer.hpp.

Read()

template<class T>

T EndianBufferReader::Read ( )

inlineprivate

Fundamental read function.

Returns

The read integer.

Definition at line 261 of file endian_buffer.hpp.

References read_pos.

Referenced by ReadStr().

ReadStr()

std::string EndianBufferReader::ReadStr ( )

inlineprivate

Read overload for string data.

Returns

The read string.

Definition at line 245 of file endian_buffer.hpp.

References Read(), and read_pos.

ReadTuple()

template<class Ttuple, size_t... Tindices>

void EndianBufferReader::ReadTuple ( Ttuple & values, std::index_sequence< Tindices... >  )

inlineprivate

Helper function to read a tuple from the buffer.

Parameters

values

The value to read into.

Definition at line 221 of file endian_buffer.hpp.

ReadVariant()

template<typename T, std::size_t I = 0>

void EndianBufferReader::ReadVariant ( uint8_t index, T & variant )

inlineprivate

Definition at line 227 of file endian_buffer.hpp.

rewind()

void EndianBufferReader::rewind ( )

inline

Definition at line 163 of file endian_buffer.hpp.

ToValue()

template<typename Tvalue>

Tvalue EndianBufferReader::ToValue ( std::span< const uint8_t > buffer )

inlinestatic

Definition at line 207 of file endian_buffer.hpp.

Field Documentation

buffer

std::span<const uint8_t> EndianBufferReader::buffer

private

Reference to storage buffer.

Definition at line 156 of file endian_buffer.hpp.

read_pos

size_t EndianBufferReader::read_pos = 0

private

Current read position.

Definition at line 158 of file endian_buffer.hpp.

Referenced by Read(), and ReadStr().

---

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

• src/misc/endian_buffer.hpp