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 ()
int	GetVersion () const
int	GetType () const
	CBufferedFile (const CBufferedFile &)=delete
CBufferedFile &	operator= (const CBufferedFile &)=delete
void	fclose ()
bool	eof () const
void	read (char *pch, size_t nSize)
uint64_t	GetPos ()
bool	SetPos (uint64_t nPos)
	rewind to a given reading position More...
bool	SetLimit (uint64_t nPos=std::numeric_limits< uint64_t >::max())
	prevent reading beyond a certain position no argument removes the limit More...
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 566 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 599 of file streams.h.

~CBufferedFile()

CBufferedFile::~CBufferedFile ( )

inline

Definition at line 607 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 628 of file streams.h.

Here is the caller graph for this function:

fclose()

void CBufferedFile::fclose ( )

inline

Definition at line 619 of file streams.h.

Here is the caller graph for this function:

Fill()

bool CBufferedFile::Fill ( )

inlineprotected

Definition at line 581 of file streams.h.

Here is the caller graph for this function:

FindByte()

void CBufferedFile::FindByte ( char  ch )

inline

Definition at line 694 of file streams.h.

Here is the call graph for this function:

GetPos()

uint64_t CBufferedFile::GetPos ( )

inline

Definition at line 655 of file streams.h.

Here is the caller graph for this function:

GetType()

int CBufferedFile::GetType ( ) const

inline

Definition at line 613 of file streams.h.

GetVersion()

int CBufferedFile::GetVersion ( ) const

inline

Definition at line 612 of file streams.h.

operator=()

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

delete

operator>>()

template<typename T >

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

inline

Definition at line 687 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 634 of file streams.h.

Here is the call graph for this function:

SetLimit()

bool CBufferedFile::SetLimit ( uint64_t  nPos = std::numeric_limits<uint64_t>::max() )

inline

prevent reading beyond a certain position no argument removes the limit

Definition at line 679 of file streams.h.

Here is the caller graph for this function:

SetPos()

bool CBufferedFile::SetPos ( uint64_t  nPos )

inline

rewind to a given reading position

Definition at line 661 of file streams.h.

Here is the caller graph for this function:

Member Data Documentation

nReadLimit

uint64_t CBufferedFile::nReadLimit

private

Definition at line 575 of file streams.h.

nReadPos

uint64_t CBufferedFile::nReadPos

private

Definition at line 574 of file streams.h.

nRewind

uint64_t CBufferedFile::nRewind

private

Definition at line 576 of file streams.h.

nSrcPos

uint64_t CBufferedFile::nSrcPos

private

Definition at line 573 of file streams.h.

nType

const int CBufferedFile::nType

private

Definition at line 569 of file streams.h.

nVersion

const int CBufferedFile::nVersion

private

Definition at line 570 of file streams.h.

src

FILE* CBufferedFile::src

private

Definition at line 572 of file streams.h.

vchBuf

std::vector<char> CBufferedFile::vchBuf

private

Definition at line 577 of file streams.h.

---

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

• src/streams.h