Gamedev Framework (gf) 1.2.0
A C++17 framework for 2D games
Public Member Functions | Related Functions | List of all members
gf::Deserializer Class Reference
Core » Serialization

A deserializer from a binary file. More...

#include <gf/Serialization.h>

Public Member Functions

 Deserializer (InputStream &stream)
 Constructor. More...
 
uint16_t getVersion () const
 Get the version of the current archive format. More...
 
bool readBoolean (bool &data)
 Read a boolean object. More...
 
bool readChar (char &data)
 Read a char. More...
 
bool readSigned8 (int8_t &data)
 Read a signed integer object. More...
 
bool readSigned16 (int16_t &data)
 Read a signed integer object. More...
 
bool readSigned32 (int32_t &data)
 Read a signed integer object. More...
 
bool readSigned64 (int64_t &data)
 Read a signed integer object. More...
 
bool readUnsigned8 (uint8_t &data)
 Read an unsigned integer object. More...
 
bool readUnsigned16 (uint16_t &data)
 Read an unsigned integer object. More...
 
bool readUnsigned32 (uint32_t &data)
 Read an unsigned integer object. More...
 
bool readUnsigned64 (uint64_t &data)
 Read an unsigned integer object. More...
 
bool readFloat (float &data)
 Read a single precison float object. More...
 
bool readDouble (double &data)
 Read a double precison float object. More...
 
bool readString (char *data, std::size_t size)
 Read a string body. More...
 
bool readSizeHeader (std::size_t &size)
 Read a size header. More...
 

Related Functions

(Note that these are not member functions.)

GF_CORE_API Deserializer & operator| (Deserializer &ar, Path &path)
 Deserialize a path. More...
 
GF_CORE_API Deserializer & operator| (Deserializer &ar, PointSequence &sequence)
 Deserialize a sequence. More...
 
Deserializer & operator| (Deserializer &ar, Polygon &polygon)
 Deserialize a polygon. More...
 
GF_CORE_API Deserializer & operator| (Deserializer &ar, Polyline &polyline)
 Deserialize a polyline. More...
 
GF_CORE_API Deserializer & operator| (Deserializer &ar, bool &data)
 Deserialize a bool object. More...
 
GF_CORE_API Deserializer & operator| (Deserializer &ar, char &data)
 Deserialize a char object. More...
 
GF_CORE_API Deserializer & operator| (Deserializer &ar, uint8_t &data)
 Deserialize an unsigned integer object. More...
 
GF_CORE_API Deserializer & operator| (Deserializer &ar, uint16_t &data)
 Deserialize an unsigned integer object. More...
 
GF_CORE_API Deserializer & operator| (Deserializer &ar, uint32_t &data)
 Deserialize an unsigned integer object. More...
 
GF_CORE_API Deserializer & operator| (Deserializer &ar, uint64_t &data)
 Deserialize an unsigned integer object. More...
 
GF_CORE_API Deserializer & operator| (Deserializer &ar, int8_t &data)
 Deserialize a signed integer object. More...
 
GF_CORE_API Deserializer & operator| (Deserializer &ar, int16_t &data)
 Deserialize a signed integer object. More...
 
GF_CORE_API Deserializer & operator| (Deserializer &ar, int32_t &data)
 Deserialize a signed integer object. More...
 
GF_CORE_API Deserializer & operator| (Deserializer &ar, int64_t &data)
 Deserialize a signed integer object. More...
 
template<typename T , typename E = typename std::enable_if<std::is_enum<T>::value, T>::type>
Deserializer & operator| (Deserializer &ar, T &data)
 Deserialize an enum object. More...
 
template<typename E >
Deserializer & operator| (Deserializer &ar, Flags< E > &data)
 Deserialize flags. More...
 
GF_CORE_API Deserializer & operator| (Deserializer &ar, float &data)
 Deserialize a single precision float object. More...
 
GF_CORE_API Deserializer & operator| (Deserializer &ar, double &data)
 Deserialize a double precision float object. More...
 
GF_CORE_API Deserializer & operator| (Deserializer &ar, std::string &str)
 Deserialize a string object. More...
 
template<typename T >
Deserializer & operator| (Deserializer &ar, Span< T > array)
 Deserialize an array object. More...
 
template<typename T , std::size_t N>
Deserializer & operator| (Deserializer &ar, T(&array)[N])
 Deserialize an array object. More...
 
template<typename T , std::size_t N>
Deserializer & operator| (Deserializer &ar, std::array< T, N > &array)
 Deserialize an array object. More...
 
template<typename T >
Deserializer & operator| (Deserializer &ar, std::vector< T > &array)
 Deserialize an array object. More...
 
template<typename T >
Deserializer & operator| (Deserializer &ar, std::set< T > &set)
 Deserialize a set object. More...
 
template<typename T >
Deserializer & operator| (Deserializer &ar, std::unordered_set< T > &set)
 Deserialize a set object. More...
 
template<typename K , typename V >
Deserializer & operator| (Deserializer &ar, std::map< K, V > &map)
 Deserialize a map object. More...
 
template<typename K , typename V >
Deserializer & operator| (Deserializer &ar, std::unordered_map< K, V > &map)
 Deserialize a map object. More...
 
GF_CORE_API Deserializer & operator| (Deserializer &ar, Time &time)
 Deserialize a time. More...
 

Detailed Description

A deserializer from a binary file.

You should not use the methods in this class. Prefer using and overloading operator |.

See also
gf::Serializer

Constructor & Destructor Documentation

◆ Deserializer()

gf::Deserializer::Deserializer ( InputStream &  stream)

Constructor.

Parameters
streamThe input stream

Member Function Documentation

◆ getVersion()

uint16_t gf::Deserializer::getVersion ( ) const
inline

Get the version of the current archive format.

◆ readBoolean()

bool gf::Deserializer::readBoolean ( bool &  data)

Read a boolean object.

Returns
True if there was no error while reading

◆ readChar()

bool gf::Deserializer::readChar ( char &  data)

Read a char.

Returns
True if there was no error while reading

◆ readDouble()

bool gf::Deserializer::readDouble ( double &  data)

Read a double precison float object.

Returns
True if there was no error while reading

◆ readFloat()

bool gf::Deserializer::readFloat ( float &  data)

Read a single precison float object.

Returns
True if there was no error while reading

◆ readSigned16()

bool gf::Deserializer::readSigned16 ( int16_t &  data)

Read a signed integer object.

Returns
True if there was no error while reading

◆ readSigned32()

bool gf::Deserializer::readSigned32 ( int32_t &  data)

Read a signed integer object.

Returns
True if there was no error while reading

◆ readSigned64()

bool gf::Deserializer::readSigned64 ( int64_t &  data)

Read a signed integer object.

Returns
True if there was no error while reading

◆ readSigned8()

bool gf::Deserializer::readSigned8 ( int8_t &  data)

Read a signed integer object.

Returns
True if there was no error while reading

◆ readSizeHeader()

bool gf::Deserializer::readSizeHeader ( std::size_t &  size)

Read a size header.

Returns
True if there was no error while reading

◆ readString()

bool gf::Deserializer::readString ( char *  data,
std::size_t  size 
)

Read a string body.

Returns
True if there was no error while reading

◆ readUnsigned16()

bool gf::Deserializer::readUnsigned16 ( uint16_t &  data)

Read an unsigned integer object.

Returns
True if there was no error while reading

◆ readUnsigned32()

bool gf::Deserializer::readUnsigned32 ( uint32_t &  data)

Read an unsigned integer object.

Returns
True if there was no error while reading

◆ readUnsigned64()

bool gf::Deserializer::readUnsigned64 ( uint64_t &  data)

Read an unsigned integer object.

Returns
True if there was no error while reading

◆ readUnsigned8()

bool gf::Deserializer::readUnsigned8 ( uint8_t &  data)

Read an unsigned integer object.

Returns
True if there was no error while reading

Friends And Related Function Documentation

◆ operator|() [1/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
bool &  data 
)
related

Deserialize a bool object.

◆ operator|() [2/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
char &  data 
)
related

Deserialize a char object.

◆ operator|() [3/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
double &  data 
)
related

Deserialize a double precision float object.

◆ operator|() [4/28]

template<typename E >
Deserializer & operator| ( Deserializer &  ar,
Flags< E > &  data 
)
related

Deserialize flags.

◆ operator|() [5/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
float &  data 
)
related

Deserialize a single precision float object.

◆ operator|() [6/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
int16_t &  data 
)
related

Deserialize a signed integer object.

◆ operator|() [7/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
int32_t &  data 
)
related

Deserialize a signed integer object.

◆ operator|() [8/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
int64_t &  data 
)
related

Deserialize a signed integer object.

◆ operator|() [9/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
int8_t &  data 
)
related

Deserialize a signed integer object.

◆ operator|() [10/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
Path &  path 
)
related

Deserialize a path.

◆ operator|() [11/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
PointSequence &  sequence 
)
related

Deserialize a sequence.

◆ operator|() [12/28]

Deserializer & operator| ( Deserializer &  ar,
Polygon &  polygon 
)
related

Deserialize a polygon.

◆ operator|() [13/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
Polyline &  polyline 
)
related

Deserialize a polyline.

◆ operator|() [14/28]

template<typename T >
Deserializer & operator| ( Deserializer &  ar,
Span< T >  array 
)
related

Deserialize an array object.

◆ operator|() [15/28]

template<typename T , std::size_t N>
Deserializer & operator| ( Deserializer &  ar,
std::array< T, N > &  array 
)
related

Deserialize an array object.

◆ operator|() [16/28]

template<typename K , typename V >
Deserializer & operator| ( Deserializer &  ar,
std::map< K, V > &  map 
)
related

Deserialize a map object.

◆ operator|() [17/28]

template<typename T >
Deserializer & operator| ( Deserializer &  ar,
std::set< T > &  set 
)
related

Deserialize a set object.

◆ operator|() [18/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
std::string &  str 
)
related

Deserialize a string object.

◆ operator|() [19/28]

template<typename K , typename V >
Deserializer & operator| ( Deserializer &  ar,
std::unordered_map< K, V > &  map 
)
related

Deserialize a map object.

◆ operator|() [20/28]

template<typename T >
Deserializer & operator| ( Deserializer &  ar,
std::unordered_set< T > &  set 
)
related

Deserialize a set object.

◆ operator|() [21/28]

template<typename T >
Deserializer & operator| ( Deserializer &  ar,
std::vector< T > &  array 
)
related

Deserialize an array object.

◆ operator|() [22/28]

template<typename T , typename E = typename std::enable_if<std::is_enum<T>::value, T>::type>
Deserializer & operator| ( Deserializer &  ar,
T &  data 
)
related

Deserialize an enum object.

◆ operator|() [23/28]

template<typename T , std::size_t N>
Deserializer & operator| ( Deserializer &  ar,
T(&)  array[N] 
)
related

Deserialize an array object.

◆ operator|() [24/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
Time &  time 
)
related

Deserialize a time.

◆ operator|() [25/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
uint16_t &  data 
)
related

Deserialize an unsigned integer object.

◆ operator|() [26/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
uint32_t &  data 
)
related

Deserialize an unsigned integer object.

◆ operator|() [27/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
uint64_t &  data 
)
related

Deserialize an unsigned integer object.

◆ operator|() [28/28]

GF_CORE_API Deserializer & operator| ( Deserializer &  ar,
uint8_t &  data 
)
related

Deserialize an unsigned integer object.

Generated by doxygen 1.9.4