CFlatDB< T > Class Template Reference

Generic Dumping and Loading

More...

#include <flat-database.h>

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

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

Private Member Functions
bool	Write (const T &objToSave)
ReadResult	Read (T &objToLoad, bool fDryRun=false)

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 21 of file flat-database.h.

Member Enumeration Documentation

ReadResult

template<typename T>

enum CFlatDB::ReadResult

private

Enumerator
Ok
FileError
HashReadError
IncorrectHash
IncorrectMagicMessage
IncorrectMagicNumber
IncorrectFormat

Definition at line 25 of file flat-database.h.

Constructor & Destructor Documentation

CFlatDB()

template<typename T>

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

inline

Definition at line 166 of file flat-database.h.

References GetDataDir(), CFlatDB< T >::pathDB, CFlatDB< T >::strFilename, and CFlatDB< T >::strMagicMessage.

Member Function Documentation

Dump()

template<typename T>

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

inline

Definition at line 195 of file flat-database.h.

References CFlatDB< T >::FileError, GetTimeMillis(), CFlatDB< T >::IncorrectFormat, LogPrintf, CFlatDB< T >::Ok, CFlatDB< T >::Read(), CFlatDB< T >::strFilename, and CFlatDB< T >::Write().

Referenced by AppInitMain(), and PrepareShutdown().

Load()

template<typename T>

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

inline

Definition at line 173 of file flat-database.h.

References CFlatDB< T >::FileError, CFlatDB< T >::IncorrectFormat, LogPrintf, CFlatDB< T >::Ok, CFlatDB< T >::Read(), and CFlatDB< T >::strFilename.

Referenced by AppInitMain().

Read()

template<typename T>

ReadResult CFlatDB< T >::Read ( T &  objToLoad, bool  fDryRun = false  )

inlineprivate

Definition at line 74 of file flat-database.h.

References CDataStream::begin(), CLIENT_VERSION, CDataStream::end(), error(), CFlatDB< T >::FileError, FLATDATA, fsbridge::fopen(), GetTimeMillis(), Hash(), CFlatDB< T >::HashReadError, CFlatDB< T >::IncorrectFormat, CFlatDB< T >::IncorrectHash, CFlatDB< T >::IncorrectMagicMessage, CFlatDB< T >::IncorrectMagicNumber, LogPrintf, CFlatDB< T >::Ok, Params(), CFlatDB< T >::pathDB, SER_DISK, CFlatDB< T >::strFilename, and CFlatDB< T >::strMagicMessage.

Referenced by CFlatDB< T >::Dump(), and CFlatDB< T >::Load().

Write()

template<typename T>

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

inlineprivate

Definition at line 39 of file flat-database.h.

References CDataStream::begin(), CLIENT_VERSION, CDataStream::end(), error(), fileout, FLATDATA, fsbridge::fopen(), GetTimeMillis(), Hash(), LogPrintf, Params(), CFlatDB< T >::pathDB, SER_DISK, CFlatDB< T >::strFilename, and CFlatDB< T >::strMagicMessage.

Referenced by CFlatDB< T >::Dump().

Member Data Documentation

pathDB

template<typename T>

fs::path CFlatDB< T >::pathDB

private

Definition at line 35 of file flat-database.h.

Referenced by CFlatDB< T >::CFlatDB(), CFlatDB< T >::Read(), and CFlatDB< T >::Write().

strFilename

template<typename T>

std::string CFlatDB< T >::strFilename

private

Definition at line 36 of file flat-database.h.

Referenced by CFlatDB< T >::CFlatDB(), CFlatDB< T >::Dump(), CFlatDB< T >::Load(), CFlatDB< T >::Read(), and CFlatDB< T >::Write().

strMagicMessage

template<typename T>

std::string CFlatDB< T >::strMagicMessage

private

Definition at line 37 of file flat-database.h.

Referenced by CFlatDB< T >::CFlatDB(), CFlatDB< T >::Read(), and CFlatDB< T >::Write().

---

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

• src/flat-database.h