Bitcoin Core  21.99.0
P2P Digital Currency
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
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
 
CBufferedFileoperator= (const CBufferedFile &)=delete
 
int GetVersion () const
 
int GetType () const
 
void fclose ()
 
bool eof () const
 check whether we're at the end of the source file More...
 
void read (char *pch, size_t nSize)
 read a number of bytes More...
 
uint64_t GetPos () const
 return the current reading position More...
 
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 >
CBufferedFileoperator>> (T &&obj)
 
void FindByte (char ch)
 search for a given byte in the stream, and remain positioned on it More...
 

Protected Member Functions

bool Fill ()
 read data from the source to fill the buffer More...
 

Private Attributes

const int nType
 
const int nVersion
 
FILE * src
 source file More...
 
uint64_t nSrcPos
 how many bytes have been read from source More...
 
uint64_t nReadPos
 how many bytes have been read from this More...
 
uint64_t nReadLimit
 up to which position we're allowed to read More...
 
uint64_t nRewind
 how many bytes we guarantee to rewind More...
 
std::vector< char > vchBuf
 the buffer More...
 

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 673 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 705 of file streams.h.

◆ ~CBufferedFile()

CBufferedFile::~CBufferedFile ( )
inline

Definition at line 713 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

check whether we're at the end of the source file

Definition at line 734 of file streams.h.

◆ fclose()

void CBufferedFile::fclose ( )
inline

Definition at line 725 of file streams.h.

Here is the caller graph for this function:

◆ Fill()

bool CBufferedFile::Fill ( )
inlineprotected

read data from the source to fill the buffer

Definition at line 688 of file streams.h.

Here is the caller graph for this function:

◆ FindByte()

void CBufferedFile::FindByte ( char  ch)
inline

search for a given byte in the stream, and remain positioned on it

Definition at line 797 of file streams.h.

Here is the call graph for this function:

◆ GetPos()

uint64_t CBufferedFile::GetPos ( ) const
inline

return the current reading position

Definition at line 759 of file streams.h.

◆ GetType()

int CBufferedFile::GetType ( ) const
inline

Definition at line 723 of file streams.h.

◆ GetVersion()

int CBufferedFile::GetVersion ( ) const
inline

Definition at line 722 of file streams.h.

◆ operator=()

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

◆ operator>>()

template<typename T >
CBufferedFile& CBufferedFile::operator>> ( T &&  obj)
inline

Definition at line 790 of file streams.h.

Here is the call graph for this function:

◆ read()

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

read a number of bytes

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

◆ SetPos()

bool CBufferedFile::SetPos ( uint64_t  nPos)
inline

rewind to a given reading position

Definition at line 764 of file streams.h.

Member Data Documentation

◆ nReadLimit

uint64_t CBufferedFile::nReadLimit
private

up to which position we're allowed to read

Definition at line 682 of file streams.h.

◆ nReadPos

uint64_t CBufferedFile::nReadPos
private

how many bytes have been read from this

Definition at line 681 of file streams.h.

◆ nRewind

uint64_t CBufferedFile::nRewind
private

how many bytes we guarantee to rewind

Definition at line 683 of file streams.h.

◆ nSrcPos

uint64_t CBufferedFile::nSrcPos
private

how many bytes have been read from source

Definition at line 680 of file streams.h.

◆ nType

const int CBufferedFile::nType
private

Definition at line 676 of file streams.h.

◆ nVersion

const int CBufferedFile::nVersion
private

Definition at line 677 of file streams.h.

◆ src

FILE* CBufferedFile::src
private

source file

Definition at line 679 of file streams.h.

◆ vchBuf

std::vector<char> CBufferedFile::vchBuf
private

the buffer

Definition at line 684 of file streams.h.


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