serialbox Namespace Reference

Namespace of the serialbox library. More...

Classes
class	Archive
	Abstract interface for Archives. More...
class	ArchiveFactory
	Factory to create Archives. More...
struct	ArrayUtil
	Utilites for Array. More...
class	BinaryArchive
	Non-portable binary archive. More...
class	BinaryBuffer
	Contiguous buffer with support for sliced loading. More...
class	ConstStorageViewIterator
	Non-mutable forward iterator to access the data of a StorageView. More...
class	Exception
	Exception class which stores a human-readable error description. More...
struct	FieldID
	Uniquely identifiy a field. More...
class	FieldMap
	Hash-map to query the meta-information of the registered fields. More...
class	FieldMetainfoImpl
	Meta-information of a data field. More...
class	Hash
	Hash algorithm interface. More...
class	HashFactory
	Factory to create Hash algorithms. More...
struct	IsArray
	Check if type T is an Array. More...
struct	IsArray< Array< T > >
struct	IsSupported
	Check if the Type is recognized by serialbox i.e maps to a type-id in TypeID. More...
class	Logging
	Control the logging behaviour. More...
struct	MakePrimitive
	Return the primtive type (T::value_type) if T is an Array or T otherwise. More...
class	match_cv_qualifier
	Utility for constructing identically cv-qualified types. More...
class	MD5
	Implementation of MD5 cryptographic hash algorithm. More...
class	MetainfoMapImpl
	Hash-map of meta-information of the form key = value pair or key = {value1, ..., valueN} More...
class	MetainfoValueImpl
	Represent an immutable meta information value as a type-id and type-erased data. More...
class	MockArchive
	Mock archive. More...
class	NetCDFArchive
	Archive based on NetCDF. More...
class	SavepointImpl
	Shared implementation of the Savepoint. More...
class	SavepointVector
	The SavepointVector manages the registered savepoints and their mapping to the stored fields. More...
class	SerializerImpl
	Shared implementation of the Serializer. More...
class	SHA256
	Implementation of the SHA-1 (Secure Hash Algorithm 1) More...
class	Slice
	Specification of the slice indices which is used for partial loading of serialized data. More...
struct	SliceTriple
	Slice per dimension. More...
class	StorageView
	Represent a mutable view to a multi-dimensional storage. More...
class	StorageViewIterator
	Mutable forward iterator to access the data of a StorageView. More...
class	StorageViewIteratorBase
	Forward iterator to access the data of a StorageView. More...
class	Timer
	High resolution timer. More...
struct	ToType
	Convert TypeID to C++ type. More...
struct	ToType< TypeID::ArrayOfBoolean >
struct	ToType< TypeID::ArrayOfFloat32 >
struct	ToType< TypeID::ArrayOfFloat64 >
struct	ToType< TypeID::ArrayOfInt32 >
struct	ToType< TypeID::ArrayOfInt64 >
struct	ToType< TypeID::ArrayOfString >
struct	ToType< TypeID::Boolean >
struct	ToType< TypeID::Float32 >
struct	ToType< TypeID::Float64 >
struct	ToType< TypeID::Int32 >
struct	ToType< TypeID::Int64 >
struct	ToType< TypeID::String >
struct	ToTypeID
	Convert C++ type T to TypeID. More...
struct	ToTypeID< Array< bool > >
struct	ToTypeID< Array< double > >
struct	ToTypeID< Array< float > >
struct	ToTypeID< Array< std::int32_t > >
struct	ToTypeID< Array< std::int64_t > >
struct	ToTypeID< Array< std::string > >
struct	ToTypeID< bool >
struct	ToTypeID< double >
struct	ToTypeID< float >
struct	ToTypeID< std::int32_t >
struct	ToTypeID< std::int64_t >
struct	ToTypeID< std::string >
struct	TypeUtil
	Utilites for TypeID. More...
struct	Version
	Utility to deal with Serialbox versions. More...

Typedefs
template<class T >
using	Array = std::vector< T >
	Array class used by serialbox to store meta-information.
using	Byte = char
	Represent a byte i.e sizeof(Byte) == 1.

Enumerations
enum	OpenModeKind : std::uint8_t { Read = 0, Write, Append }
	Policy for opening files in the Serializer and Archive.
enum	TypeID : int {   Invalid = 0, Boolean, Int32, Int64,   Float32, Float64, String, Array = 0x10,   ArrayOfBoolean = Array | Boolean, ArrayOfInt32 = Array | Int32, ArrayOfInt64 = Array | Int64, ArrayOfFloat32 = Array | Float32,   ArrayOfFloat64 = Array | Float64, ArrayOfString = Array | String }
	Type-id of types recognized by serialbox. More...

Functions
bool	operator== (const FieldID &left, const FieldID &right)
	Check for equality of FieldIDs.
bool	operator!= (const FieldID &left, const FieldID &right)
	Check for inequality of FieldIDs.
std::ostream &	operator<< (std::ostream &stream, const FieldID &f)
	Convert FieldID to stream.
std::ostream &	operator<< (std::ostream &stream, const FieldMap &s)
std::ostream &	operator<< (std::ostream &stream, const FieldMetainfoImpl &f)
std::ostream &	operator<< (std::ostream &stream, const MetainfoMapImpl &s)
std::ostream &	operator<< (std::ostream &stream, const SavepointImpl &s)
std::ostream &	operator<< (std::ostream &stream, const SavepointVector &s)
std::ostream &	operator<< (std::ostream &stream, const SerializerImpl &s)
std::ostream &	operator<< (std::ostream &stream, const StorageView &s)
void	swap (StorageView &a, StorageView &b) noexcept
std::ostream &	operator<< (std::ostream &stream, const OpenModeKind &mode)
	Convert OpenModeKind to stream.
std::ostream &	operator<< (std::ostream &stream, const TypeID &t)
	Convert TypeID to stream.
SERIALBOX_ATTRIBUTE_NORETURN void	serialbox_unreachable_internal (const char *msg, const char *file, unsigned line)

Detailed Description

Namespace of the serialbox library.