CBufferedFile Class Reference

Non-refcounted RAII wrapper around a FILE* that implements a ring buffer to deserialize from. More...

#include <streams.h>

Public Member Functions
	CBufferedFile (FILE *fileIn, uint64_t nBufSize, uint64_t nRewindIn, int nTypeIn, int nVersionIn)
	~CBufferedFile ()
	CBufferedFile (const CBufferedFile &)=delete
CBufferedFile &	operator= (const CBufferedFile &)=delete
int	GetVersion () const
int	GetType () const
void	fclose ()
bool	eof () const
void	read (char *pch, size_t nSize)
uint64_t	GetPos () const
bool	SetPos (uint64_t nPos)
bool	Seek (uint64_t nPos)
bool	SetLimit (uint64_t nPos=(uint64_t)(-1))
template<typename T >
CBufferedFile &	operator>> (T &&obj)
void	FindByte (char ch)

Protected Member Functions
bool	Fill ()

Private Attributes
const int	nType
const int	nVersion
FILE *	src
uint64_t	nSrcPos
uint64_t	nReadPos
uint64_t	nReadLimit
uint64_t	nRewind
std::vector< char >	vchBuf

Detailed Description

Non-refcounted RAII wrapper around a FILE* that implements a ring buffer to deserialize from.

It guarantees the ability to rewind a given number of bytes.

Will automatically close the file when it goes out of scope if not null. If you need to close the file early, use file.fclose() instead of fclose(file).

Definition at line 730 of file streams.h.

Constructor & Destructor Documentation

CBufferedFile() [1/2]

CBufferedFile::CBufferedFile ( FILE *  fileIn, uint64_t  nBufSize, uint64_t  nRewindIn, int  nTypeIn, int  nVersionIn  )

inline

Definition at line 763 of file streams.h.

~CBufferedFile()

CBufferedFile::~CBufferedFile ( )

inline

Definition at line 769 of file streams.h.

Here is the call graph for this function:

CBufferedFile() [2/2]

CBufferedFile::CBufferedFile ( const CBufferedFile &  )

delete

Member Function Documentation

eof()

bool CBufferedFile::eof ( ) const

inline

Definition at line 790 of file streams.h.

fclose()

void CBufferedFile::fclose ( )

inline

Definition at line 781 of file streams.h.

Here is the caller graph for this function:

Fill()

bool CBufferedFile::Fill ( )

inlineprotected

Definition at line 745 of file streams.h.

Here is the caller graph for this function:

FindByte()

void CBufferedFile::FindByte ( char  ch )

inline

Definition at line 864 of file streams.h.

Here is the call graph for this function:

GetPos()

uint64_t CBufferedFile::GetPos ( ) const

inline

Definition at line 817 of file streams.h.

GetType()

int CBufferedFile::GetType ( ) const

inline

Definition at line 779 of file streams.h.

GetVersion()

int CBufferedFile::GetVersion ( ) const

inline

Definition at line 778 of file streams.h.

operator=()

CBufferedFile& CBufferedFile::operator= ( const CBufferedFile &  )

delete

operator>>()

template<typename T >

CBufferedFile& CBufferedFile::operator>> ( T &&  obj )

inline

Definition at line 857 of file streams.h.

Here is the call graph for this function:

read()

void CBufferedFile::read ( char *  pch, size_t  nSize  )

inline

Definition at line 795 of file streams.h.

Here is the call graph for this function:

Seek()

bool CBufferedFile::Seek ( uint64_t  nPos )

inline

Definition at line 835 of file streams.h.

SetLimit()

bool CBufferedFile::SetLimit ( uint64_t  nPos = (uint64_t)(-1) )

inline

Definition at line 849 of file streams.h.

SetPos()

bool CBufferedFile::SetPos ( uint64_t  nPos )

inline

Definition at line 822 of file streams.h.

Member Data Documentation

nReadLimit

uint64_t CBufferedFile::nReadLimit

private

Definition at line 739 of file streams.h.

nReadPos

uint64_t CBufferedFile::nReadPos

private

Definition at line 738 of file streams.h.

nRewind

uint64_t CBufferedFile::nRewind

private

Definition at line 740 of file streams.h.

nSrcPos

uint64_t CBufferedFile::nSrcPos

private

Definition at line 737 of file streams.h.

nType

const int CBufferedFile::nType

private

Definition at line 733 of file streams.h.

nVersion

const int CBufferedFile::nVersion

private

Definition at line 734 of file streams.h.

src

FILE* CBufferedFile::src

private

Definition at line 736 of file streams.h.

vchBuf

std::vector<char> CBufferedFile::vchBuf

private

Definition at line 741 of file streams.h.

---

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

• src/streams.h