gf::Deserializer Class Reference

A deserializer from a binary file. More...

#include <gf/Serialization.h>

Public Member Functions
	Deserializer (const Path &filename)
	Constructor. More...
	operator bool () const
	Conversion to boolean. 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.)
Deserializer &	operator| (Deserializer &ar, bool &data)
	Deserialize a bool object. More...
Deserializer &	operator| (Deserializer &ar, char &data)
	Deserialize a char object. More...
Deserializer &	operator| (Deserializer &ar, uint8_t &data)
	Deserialize an unsigned integer object. More...
Deserializer &	operator| (Deserializer &ar, uint16_t &data)
	Deserialize an unsigned integer object. More...
Deserializer &	operator| (Deserializer &ar, uint32_t &data)
	Deserialize an unsigned integer object. More...
Deserializer &	operator| (Deserializer &ar, uint64_t &data)
	Deserialize an unsigned integer object. More...
Deserializer &	operator| (Deserializer &ar, int8_t &data)
	Deserialize a signed integer object. More...
Deserializer &	operator| (Deserializer &ar, int16_t &data)
	Deserialize a signed integer object. More...
Deserializer &	operator| (Deserializer &ar, int32_t &data)
	Deserialize a signed integer object. More...
Deserializer &	operator| (Deserializer &ar, int64_t &data)
	Deserialize a signed integer object. More...
Deserializer &	operator| (Deserializer &ar, float &data)
	Deserialize a single precision float object. More...
Deserializer &	operator| (Deserializer &ar, double &data)
	Deserialize a double precision float object. More...
Deserializer &	operator| (Deserializer &ar, BufferRef< char > str)
	Deserialize a string object. More...
Deserializer &	operator| (Deserializer &ar, std::string &str)
	Deserialize a string object. More...
template<typename T >
Deserializer &	operator| (Deserializer &ar, BufferRef< 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...
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

(

const Path &

filename

)

Constructor.

Parameters

filename

The name of the binary file

Member Function Documentation

getVersion()

uint16_t gf::Deserializer::getVersion ( ) const

inline

Get the version of the current archive format.

operator bool()

gf::Deserializer::operator bool ( ) const

inline

Conversion to boolean.

Returns

True if the archive exists and was opened

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/23]

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

related

Deserialize a bool object.

operator|() [2/23]

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

related

Deserialize a char object.

operator|() [3/23]

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

related

Deserialize an unsigned integer object.

operator|() [4/23]

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

related

Deserialize an unsigned integer object.

operator|() [5/23]

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

related

Deserialize an unsigned integer object.

operator|() [6/23]

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

related

Deserialize an unsigned integer object.

operator|() [7/23]

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

related

Deserialize a signed integer object.

operator|() [8/23]

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

related

Deserialize a signed integer object.

operator|() [9/23]

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

related

Deserialize a signed integer object.

operator|() [10/23]

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

related

Deserialize a signed integer object.

operator|() [11/23]

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

related

Deserialize a single precision float object.

operator|() [12/23]

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

related

Deserialize a double precision float object.

operator|() [13/23]

Deserializer & operator| ( Deserializer &  ar, BufferRef< char >  str  )

related

Deserialize a string object.

operator|() [14/23]

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

related

Deserialize a string object.

operator|() [15/23]

template<typename T >

Deserializer & operator| ( Deserializer &  ar, BufferRef< T >  array  )

related

Deserialize an array object.

operator|() [16/23]

template<typename T , std::size_t N>

Deserializer & operator| ( Deserializer &  ar, T(&)  array[N]  )

related

Deserialize an array object.

operator|() [17/23]

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

related

Deserialize a time.

operator|() [18/23]

template<typename T , std::size_t N>

Deserializer & operator| ( Deserializer &  ar, std::array< T, N > &  array  )

related

Deserialize an array object.

operator|() [19/23]

template<typename T >

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

related

Deserialize an array object.

operator|() [20/23]

template<typename T >

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

related

Deserialize a set object.

operator|() [21/23]

template<typename T >

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

related

Deserialize a set object.

operator|() [22/23]

template<typename K , typename V >

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

related

Deserialize a map object.

operator|() [23/23]

template<typename K , typename V >

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

related

Deserialize a map object.