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 > requires (!std::is_class_v<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 146 of file endian_buffer.hpp.

Constructor & Destructor Documentation

EndianBufferReader()

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

inline

Definition at line 153 of file endian_buffer.hpp.

Member Function Documentation

operator>>() [1/8]

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

inline

Definition at line 159 of file endian_buffer.hpp.

operator>>() [2/8]

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

inline

Definition at line 175 of file endian_buffer.hpp.

operator>>() [3/8]

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

inline

Definition at line 158 of file endian_buffer.hpp.

operator>>() [4/8]

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

inline

Definition at line 157 of file endian_buffer.hpp.

operator>>() [5/8]

template<typename... Targs>

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

inline

Definition at line 162 of file endian_buffer.hpp.

operator>>() [6/8]

template<typename... Targs>

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

inline

Definition at line 169 of file endian_buffer.hpp.

operator>>() [7/8]

template<ConvertibleThroughBase T>

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

inline

Definition at line 181 of file endian_buffer.hpp.

operator>>() [8/8]

template<class T >
requires (!std::is_class_v<T>)

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

inline

Definition at line 188 of file endian_buffer.hpp.

Read()

template<class T >

T EndianBufferReader::Read ( )

inlineprivate

Fundamental read function.

Definition at line 244 of file endian_buffer.hpp.

References read_pos.

ReadStr()

std::string EndianBufferReader::ReadStr ( )

inlineprivate

Read overload for string data.

Definition at line 231 of file endian_buffer.hpp.

References buffer.

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.

Definition at line 210 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 216 of file endian_buffer.hpp.

rewind()

void EndianBufferReader::rewind ( )

inline

Definition at line 155 of file endian_buffer.hpp.

ToValue()

template<typename Tvalue >

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

inlinestatic

Definition at line 199 of file endian_buffer.hpp.

Field Documentation

buffer

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

private

Reference to storage buffer.

Definition at line 148 of file endian_buffer.hpp.

Referenced by ReadStr().

read_pos

size_t EndianBufferReader::read_pos = 0

private

Current read position.

Definition at line 150 of file endian_buffer.hpp.

Referenced by Read().

---

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

• src/misc/endian_buffer.hpp