CFlatDB< T > Class Template Reference

#include <flatdb.h>

Public Member Functions
	CFlatDB (const std::string &strFilenameIn, const std::string &strMagicMessageIn)
fs::path	GetDbPath () const
bool	Load (T &objToLoad)
bool	Dump (T &objToSave)

Private Types
enum	ReadResult {   Ok , FileError , HashReadError , IncorrectHash ,   IncorrectMagicMessage , IncorrectMagicNumber , IncorrectFormat }

Private Member Functions
bool	Write (T &objToSave)
ReadResult	Read (T &objToLoad)

Private Attributes
fs::path	pathDB
std::string	strFilename
std::string	strMagicMessage

Detailed Description

template<typename T>
class CFlatDB< T >

Generic Dumping and Loading

Definition at line 24 of file flatdb.h.

Member Enumeration Documentation

ReadResult

template<typename T >

enum CFlatDB::ReadResult

private

Enumerator
Ok
FileError
HashReadError
IncorrectHash
IncorrectMagicMessage
IncorrectMagicNumber
IncorrectFormat

Definition at line 31 of file flatdb.h.

Constructor & Destructor Documentation

CFlatDB()

template<typename T >

CFlatDB< T >::CFlatDB ( const std::string &  strFilenameIn, const std::string &  strMagicMessageIn  )

inline

Definition at line 146 of file flatdb.h.

Member Function Documentation

Dump()

template<typename T >

bool CFlatDB< T >::Dump ( T &  objToSave )

inline

Definition at line 172 of file flatdb.h.

Here is the call graph for this function:

GetDbPath()

template<typename T >

fs::path CFlatDB< T >::GetDbPath ( ) const

inline

Definition at line 151 of file flatdb.h.

Load()

template<typename T >

bool CFlatDB< T >::Load ( T &  objToLoad )

inline

Definition at line 153 of file flatdb.h.

Read()

template<typename T >

ReadResult CFlatDB< T >::Read ( T &  objToLoad )

inlineprivate

Definition at line 73 of file flatdb.h.

Here is the call graph for this function:

Write()

template<typename T >

bool CFlatDB< T >::Write ( T &  objToSave )

inlineprivate

Definition at line 41 of file flatdb.h.

Here is the call graph for this function:

Member Data Documentation

pathDB

template<typename T >

fs::path CFlatDB< T >::pathDB

private

Definition at line 27 of file flatdb.h.

strFilename

template<typename T >

std::string CFlatDB< T >::strFilename

private

Definition at line 28 of file flatdb.h.

strMagicMessage

template<typename T >

std::string CFlatDB< T >::strMagicMessage

private

Definition at line 29 of file flatdb.h.

---

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

• src/flatdb.h