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

#include <streams.h>

Public Member Functions
	BufferedFile (FILE *fileIn, uint64_t nBufSize, uint64_t nRewindIn, int nVersionIn)

	~BufferedFile ()

	BufferedFile (const BufferedFile &)=delete

BufferedFile &	operator= (const BufferedFile &)=delete

int	GetVersion () const

void	fclose ()

bool	eof () const
	check whether we're at the end of the source file More...

void	read (Span< std::byte > dst)
	read a number of bytes More...

void	SkipTo (const uint64_t file_pos)
	Move the read position ahead in the stream to the given position. 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 >
BufferedFile &	operator>> (T &&obj)

void	FindByte (std::byte byte)
	search for a given byte in the stream, and remain positioned on it More...

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

std::pair< std::byte *, size_t >	AdvanceStream (size_t length)
	Advance the stream's read pointer (m_read_pos) by up to 'length' bytes, filling the buffer from the file so that at least one byte is available. More...

Private Attributes
const int	nVersion

FILE *	src
	source file More...

uint64_t	nSrcPos {0}
	how many bytes have been read from source More...

uint64_t	m_read_pos {0}
	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< std::byte >	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 580 of file streams.h.

Constructor & Destructor Documentation

◆ BufferedFile() [1/2]

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

inline

Definition at line 632 of file streams.h.

◆ ~BufferedFile()

BufferedFile::~BufferedFile ( )

inline

Definition at line 640 of file streams.h.

Here is the call graph for this function:

◆ BufferedFile() [2/2]

BufferedFile::BufferedFile ( const BufferedFile & )

delete

Member Function Documentation

◆ AdvanceStream()

std::pair<std::byte*, size_t> BufferedFile::AdvanceStream ( size_t length )

inlineprivate

Advance the stream's read pointer (m_read_pos) by up to 'length' bytes, filling the buffer from the file so that at least one byte is available.

Return a pointer to the available buffer data and the number of bytes (which may be less than the requested length) that may be accessed beginning at that pointer.

Definition at line 614 of file streams.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ eof()

bool BufferedFile::eof ( ) const

inline

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

Definition at line 660 of file streams.h.

◆ fclose()

void BufferedFile::fclose ( )

inline

Definition at line 651 of file streams.h.

Here is the caller graph for this function:

◆ Fill()

bool BufferedFile::Fill ( )

inlineprivate

read data from the source to fill the buffer

Definition at line 593 of file streams.h.

Here is the caller graph for this function:

◆ FindByte()

void BufferedFile::FindByte ( std::byte byte )

inline

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

Definition at line 720 of file streams.h.

Here is the call graph for this function:

◆ GetPos()

uint64_t BufferedFile::GetPos ( ) const

inline

return the current reading position

Definition at line 683 of file streams.h.

◆ GetVersion()

int BufferedFile::GetVersion ( ) const

inline

Definition at line 649 of file streams.h.

◆ operator=()

BufferedFile& BufferedFile::operator= ( const BufferedFile & )

delete

◆ operator>>()

template<typename T >

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

inline

Definition at line 714 of file streams.h.

Here is the call graph for this function:

◆ read()

void BufferedFile::read ( Span< std::byte > dst )

inline

read a number of bytes

Definition at line 665 of file streams.h.

Here is the call graph for this function:

◆ SetLimit()

bool BufferedFile::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 706 of file streams.h.

◆ SetPos()

bool BufferedFile::SetPos ( uint64_t nPos )

inline

rewind to a given reading position

Definition at line 688 of file streams.h.

◆ SkipTo()

void BufferedFile::SkipTo ( const uint64_t file_pos )

inline

Move the read position ahead in the stream to the given position.

Use SetPos() to back up in the stream, not SkipTo().

Definition at line 676 of file streams.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_read_pos

uint64_t BufferedFile::m_read_pos {0}

private

how many bytes have been read from this

Definition at line 587 of file streams.h.

◆ nReadLimit

uint64_t BufferedFile::nReadLimit

private

up to which position we're allowed to read

Definition at line 588 of file streams.h.

◆ nRewind

uint64_t BufferedFile::nRewind

private

how many bytes we guarantee to rewind

Definition at line 589 of file streams.h.

◆ nSrcPos

uint64_t BufferedFile::nSrcPos {0}

private

how many bytes have been read from source

Definition at line 586 of file streams.h.

◆ nVersion

const int BufferedFile::nVersion

private

Definition at line 583 of file streams.h.

◆ src

FILE* BufferedFile::src

private

source file

Definition at line 585 of file streams.h.

◆ vchBuf

std::vector<std::byte> BufferedFile::vchBuf

private

the buffer

Definition at line 590 of file streams.h.

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

src/streams.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BufferedFile() [1/2]

◆ ~BufferedFile()

◆ BufferedFile() [2/2]

Member Function Documentation

◆ AdvanceStream()

◆ eof()

◆ fclose()

◆ Fill()

◆ FindByte()

◆ GetPos()

◆ GetVersion()

◆ operator=()

◆ operator>>()

◆ read()

◆ SetLimit()

◆ SetPos()

◆ SkipTo()

Member Data Documentation

◆ m_read_pos

◆ nReadLimit

◆ nRewind

◆ nSrcPos

◆ nVersion

◆ src

◆ vchBuf