#include <BmnFileReaderZStd.h>

Inheritance diagram for BmnFileReaderZStd:

Collaboration diagram for BmnFileReaderZStd:

Public Member Functions
	BmnFileReaderZStd (const std::string &fileName="")
	BmnFileReaderZStd (std::string &&fileName)
	BmnFileReaderZStd (const std::filesystem::path &filePath)
	BmnFileReaderZStd (std::filesystem::path &&filePath)
virtual	~BmnFileReaderZStd () override
	BmnFileReaderZStd (const BmnFileReaderZStd &)=delete
BmnFileReaderZStd &	operator= (const BmnFileReaderZStd &)=delete
	BmnFileReaderZStd (BmnFileReaderZStd &&) noexcept=delete
BmnFileReaderZStd &	operator= (BmnFileReaderZStd &&) noexcept=delete
virtual void	Open (const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary) override
virtual void	Close () noexcept override
virtual int64_t	Read (void *dataToFill, const int64_t sizeToFill) override
virtual int64_t	Tell () const noexcept override
virtual void	Seek (int64_t value) override
virtual bool	IsGood () const noexcept override
virtual bool	IsEOF () const noexcept override
virtual void	ClearStateFlags () override
virtual bool	IsOpen () const noexcept override
virtual BmnFileStreamResults	Uncompress (const void source, const size_t sourceTotalSize, size_t &numberOfReadBytes, void output, const size_t outputTotalSize, size_t &numberOfSetOutputBytes) override
virtual std::string	GetLastUncompressErrorDescription () const noexcept override
virtual bool	JumpsAllowed () const noexcept override
virtual void	JumpTo (size_t) override
virtual size_t	GetNumberOfDecompressedBytes () const noexcept override
virtual bool	HasReachedTheEndOfStream () const noexcept override
virtual bool	IsStreamInGoodState () const noexcept override
ZSTD_DCtx_s *	GetUnderlyingLibraryHandler () const noexcept
size_t	GetLastReadReturnValue () const noexcept
	BmnFileReaderZStd (const std::string &fileName="")
	BmnFileReaderZStd (std::string &&fileName)
	BmnFileReaderZStd (const std::filesystem::path &filePath)
	BmnFileReaderZStd (std::filesystem::path &&filePath)
virtual	~BmnFileReaderZStd () override
	BmnFileReaderZStd (const BmnFileReaderZStd &)=delete
BmnFileReaderZStd &	operator= (const BmnFileReaderZStd &)=delete
	BmnFileReaderZStd (BmnFileReaderZStd &&) noexcept=delete
BmnFileReaderZStd &	operator= (BmnFileReaderZStd &&) noexcept=delete
virtual void	Open (const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary) override
virtual void	Close () noexcept override
virtual int64_t	Read (void *dataToFill, const int64_t sizeToFill) override
virtual int64_t	Tell () const noexcept override
virtual void	Seek (int64_t value) override
virtual bool	IsGood () const noexcept override
virtual bool	IsEOF () const noexcept override
virtual void	ClearStateFlags () override
virtual bool	IsOpen () const noexcept override
virtual BmnFileStreamResults	Uncompress (const void source, const size_t sourceTotalSize, size_t &numberOfReadBytes, void output, const size_t outputTotalSize, size_t &numberOfSetOutputBytes) override
virtual std::string	GetLastUncompressErrorDescription () const noexcept override
virtual bool	JumpsAllowed () const noexcept override
virtual void	JumpTo (size_t) override
virtual size_t	GetNumberOfDecompressedBytes () const noexcept override
virtual bool	HasReachedTheEndOfStream () const noexcept override
virtual bool	IsStreamInGoodState () const noexcept override
ZSTD_DCtx_s *	GetUnderlyingLibraryHandler () const noexcept
size_t	GetLastReadReturnValue () const noexcept
Public Member Functions inherited from BmnIFileReader
	BmnIFileReader (const BmnFileType fileType, const std::string &fileName="")
	BmnIFileReader (const BmnFileType fileType, std::string &&fileName) noexcept
	BmnIFileReader (const BmnFileType fileType, const std::filesystem::path &filePath)
	BmnIFileReader (const BmnFileType fileType, std::filesystem::path &&filePath) noexcept
virtual	~BmnIFileReader ()=default
	BmnIFileReader (const BmnIFileReader &)=delete
BmnIFileReader &	operator= (const BmnIFileReader &)=delete
	BmnIFileReader (BmnIFileReader &&) noexcept=delete
BmnIFileReader &	operator= (BmnIFileReader &&) noexcept=delete
virtual void	Open (const std::string &fileName, const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)
virtual void	Open (std::string &&fileName, const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)
virtual void	Open (const std::filesystem::path &filePath, const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)
virtual void	Open (std::filesystem::path &&filePath, const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)
void	SetFilePath (const std::string &fileName)
void	SetFilePath (std::string &&fileName) noexcept
void	SetFilePath (const std::filesystem::path &filePath)
void	SetFilePath (std::filesystem::path &&filePath) noexcept
std::filesystem::path &	GetFilePath () noexcept
const std::filesystem::path &	GetFilePath () const noexcept
int64_t	GetInputFileSize () const
void	SetProcessingFlags (const BmnBinaryFileProcessingOptions) noexcept
void	AddProcessingFlags (const BmnBinaryFileProcessingOptions) noexcept
void	RemoveProcessingFlags (const BmnBinaryFileProcessingOptions) noexcept
BmnBinaryFileProcessingOptions	GetProcessingFlags () const noexcept
BmnFileType	GetFileType () const noexcept
	BmnIFileReader (const BmnFileType fileType, const std::string &fileName="")
	BmnIFileReader (const BmnFileType fileType, std::string &&fileName) noexcept
	BmnIFileReader (const BmnFileType fileType, const std::filesystem::path &filePath)
	BmnIFileReader (const BmnFileType fileType, std::filesystem::path &&filePath) noexcept
virtual	~BmnIFileReader ()=default
	BmnIFileReader (const BmnIFileReader &)=delete
BmnIFileReader &	operator= (const BmnIFileReader &)=delete
	BmnIFileReader (BmnIFileReader &&) noexcept=delete
BmnIFileReader &	operator= (BmnIFileReader &&) noexcept=delete
virtual void	Open (const std::string &fileName, const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)
virtual void	Open (std::string &&fileName, const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)
virtual void	Open (const std::filesystem::path &filePath, const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)
virtual void	Open (std::filesystem::path &&filePath, const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)
void	SetFilePath (const std::string &fileName)
void	SetFilePath (std::string &&fileName) noexcept
void	SetFilePath (const std::filesystem::path &filePath)
void	SetFilePath (std::filesystem::path &&filePath) noexcept
std::filesystem::path &	GetFilePath () noexcept
const std::filesystem::path &	GetFilePath () const noexcept
int64_t	GetInputFileSize () const
void	SetProcessingFlags (const BmnBinaryFileProcessingOptions) noexcept
void	AddProcessingFlags (const BmnBinaryFileProcessingOptions) noexcept
void	RemoveProcessingFlags (const BmnBinaryFileProcessingOptions) noexcept
BmnBinaryFileProcessingOptions	GetProcessingFlags () const noexcept
BmnFileType	GetFileType () const noexcept
Public Member Functions inherited from BmnIArchiveLibRead
	BmnIArchiveLibRead ()=default
virtual	~BmnIArchiveLibRead ()=default
	BmnIArchiveLibRead ()=default
virtual	~BmnIArchiveLibRead ()=default

Private Attributes
ZSTD_DCtx_s *	fZstdStream
BmnReaderCacheManager< 32ull 1024ull, 64ull 1024ull >	fArchiveReadManager
size_t	fNumberOfReadBytes
size_t	fLastReadReturnValue

Additional Inherited Members
Protected Member Functions inherited from BmnIFileReader
bool	PerformStandardChecksBeforeOpening (const BmnBinaryFileProcessingOptions processingFlags)
bool	PerformStandardChecksBeforeOpening (const BmnBinaryFileProcessingOptions processingFlags)
Protected Attributes inherited from BmnIFileReader
std::filesystem::path	fFilePath
BmnBinaryFileProcessingOptions	fProcessingFlags
BmnFileType	fFileType

Detailed Description

Definition at line 25 of file BmnFileReaderZStd.h.

Constructor & Destructor Documentation

◆ BmnFileReaderZStd() [1/12]

BmnFileReaderZStd::BmnFileReaderZStd ( const std::string & fileName = "" )

explicit

Definition at line 25 of file BmnFileReaderZStd.cxx.

References BmnIFileReader::BmnIFileReader(), fArchiveReadManager, fLastReadReturnValue, fNumberOfReadBytes, and fZstdStream.

Referenced by BmnFileReaderZStd(), BmnFileReaderZStd(), GetLastReadReturnValue(), GetUnderlyingLibraryHandler(), operator=(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BmnFileReaderZStd() [2/12]

BmnFileReaderZStd::BmnFileReaderZStd ( std::string && fileName )

explicit

Definition at line 40 of file BmnFileReaderZStd.cxx.

References BmnIFileReader::BmnIFileReader(), fArchiveReadManager, fLastReadReturnValue, fNumberOfReadBytes, and fZstdStream.

Here is the call graph for this function:

◆ BmnFileReaderZStd() [3/12]

BmnFileReaderZStd::BmnFileReaderZStd ( const std::filesystem::path & filePath )

explicit

Definition at line 48 of file BmnFileReaderZStd.cxx.

References BmnIFileReader::BmnIFileReader(), fArchiveReadManager, fLastReadReturnValue, fNumberOfReadBytes, and fZstdStream.

Here is the call graph for this function:

◆ BmnFileReaderZStd() [4/12]

BmnFileReaderZStd::BmnFileReaderZStd ( std::filesystem::path && filePath )

explicit

Definition at line 56 of file BmnFileReaderZStd.cxx.

References BmnIFileReader::BmnIFileReader(), fArchiveReadManager, fLastReadReturnValue, fNumberOfReadBytes, and fZstdStream.

Here is the call graph for this function:

◆ ~BmnFileReaderZStd() [1/2]

BmnFileReaderZStd::~BmnFileReaderZStd ( )

overridevirtual

Definition at line 64 of file BmnFileReaderZStd.cxx.

References Close().

Here is the call graph for this function:

◆ BmnFileReaderZStd() [5/12]

BmnFileReaderZStd::BmnFileReaderZStd ( const BmnFileReaderZStd & )

delete

References BmnFileReaderZStd().

Here is the call graph for this function:

◆ BmnFileReaderZStd() [6/12]

BmnFileReaderZStd::BmnFileReaderZStd ( BmnFileReaderZStd && )

deletenoexcept

References BmnFileReaderZStd().

Here is the call graph for this function:

◆ BmnFileReaderZStd() [7/12]

BmnFileReaderZStd::BmnFileReaderZStd ( const std::string & fileName = "" )

explicit

◆ BmnFileReaderZStd() [8/12]

BmnFileReaderZStd::BmnFileReaderZStd ( std::string && fileName )

explicit

◆ BmnFileReaderZStd() [9/12]

BmnFileReaderZStd::BmnFileReaderZStd ( const std::filesystem::path & filePath )

explicit

◆ BmnFileReaderZStd() [10/12]

BmnFileReaderZStd::BmnFileReaderZStd ( std::filesystem::path && filePath )

explicit

◆ ~BmnFileReaderZStd() [2/2]

virtual BmnFileReaderZStd::~BmnFileReaderZStd ( )

overridevirtual

◆ BmnFileReaderZStd() [11/12]

BmnFileReaderZStd::BmnFileReaderZStd ( const BmnFileReaderZStd & )

delete

References BmnFileReaderZStd().

Here is the call graph for this function:

◆ BmnFileReaderZStd() [12/12]

BmnFileReaderZStd::BmnFileReaderZStd ( BmnFileReaderZStd && )

deletenoexcept

References BmnFileReaderZStd().

Here is the call graph for this function:

Member Function Documentation

◆ ClearStateFlags() [1/2]

void BmnFileReaderZStd::ClearStateFlags ( )

overridevirtual

Implements BmnIFileReader.

Definition at line 171 of file BmnFileReaderZStd.cxx.

References fArchiveReadManager, and fLastReadReturnValue.

Referenced by ClearStateFlags(), and operator=().

Here is the caller graph for this function:

◆ ClearStateFlags() [2/2]

virtual void BmnFileReaderZStd::ClearStateFlags ( )

overridevirtual

Implements BmnIFileReader.

References ClearStateFlags().

Here is the call graph for this function:

◆ Close() [1/2]

void BmnFileReaderZStd::Close ( )

overridevirtualnoexcept

Implements BmnIFileReader.

Definition at line 93 of file BmnFileReaderZStd.cxx.

References fArchiveReadManager, fLastReadReturnValue, fNumberOfReadBytes, and fZstdStream.

Referenced by ~BmnFileReaderZStd(), Close(), operator=(), and Seek().

Here is the caller graph for this function:

◆ Close() [2/2]

virtual void BmnFileReaderZStd::Close ( )

overridevirtualnoexcept

Implements BmnIFileReader.

References Close().

Here is the call graph for this function:

◆ GetLastReadReturnValue() [1/2]

size_t BmnFileReaderZStd::GetLastReadReturnValue ( ) const

inlinenodiscardnoexcept

Definition at line 222 of file BmnFileReaderZStd.h.

References fLastReadReturnValue.

Referenced by GetLastReadReturnValue(), and operator=().

Here is the caller graph for this function:

◆ GetLastReadReturnValue() [2/2]

size_t BmnFileReaderZStd::GetLastReadReturnValue ( ) const

inlinenodiscardnoexcept

References BmnFileReaderZStd(), fArchiveReadManager, fLastReadReturnValue, fNumberOfReadBytes, fZstdStream, GetLastReadReturnValue(), and GetUnderlyingLibraryHandler().

Here is the call graph for this function:

◆ GetLastUncompressErrorDescription() [1/2]

std::string BmnFileReaderZStd::GetLastUncompressErrorDescription ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

Definition at line 213 of file BmnFileReaderZStd.cxx.

References fLastReadReturnValue.

Referenced by GetLastUncompressErrorDescription(), and operator=().

Here is the caller graph for this function:

◆ GetLastUncompressErrorDescription() [2/2]

virtual std::string BmnFileReaderZStd::GetLastUncompressErrorDescription ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

References GetLastUncompressErrorDescription().

Here is the call graph for this function:

◆ GetNumberOfDecompressedBytes() [1/2]

size_t BmnFileReaderZStd::GetNumberOfDecompressedBytes ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

Definition at line 243 of file BmnFileReaderZStd.cxx.

References fNumberOfReadBytes.

Referenced by GetNumberOfDecompressedBytes(), and operator=().

Here is the caller graph for this function:

◆ GetNumberOfDecompressedBytes() [2/2]

virtual size_t BmnFileReaderZStd::GetNumberOfDecompressedBytes ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

References GetNumberOfDecompressedBytes().

Here is the call graph for this function:

◆ GetUnderlyingLibraryHandler() [1/2]

ZSTD_DCtx_s * BmnFileReaderZStd::GetUnderlyingLibraryHandler ( ) const

inlinenodiscardnoexcept

Definition at line 217 of file BmnFileReaderZStd.h.

References BmnFileReaderZStd(), fZstdStream, and GetUnderlyingLibraryHandler().

Referenced by GetLastReadReturnValue(), GetUnderlyingLibraryHandler(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUnderlyingLibraryHandler() [2/2]

ZSTD_DCtx_s * BmnFileReaderZStd::GetUnderlyingLibraryHandler ( ) const

inlinenodiscardnoexcept

References GetUnderlyingLibraryHandler().

Here is the call graph for this function:

◆ HasReachedTheEndOfStream() [1/2]

bool BmnFileReaderZStd::HasReachedTheEndOfStream ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

Definition at line 248 of file BmnFileReaderZStd.cxx.

References fLastReadReturnValue.

Referenced by HasReachedTheEndOfStream(), and operator=().

Here is the caller graph for this function:

◆ HasReachedTheEndOfStream() [2/2]

virtual bool BmnFileReaderZStd::HasReachedTheEndOfStream ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

References HasReachedTheEndOfStream().

Here is the call graph for this function:

◆ IsEOF() [1/2]

bool BmnFileReaderZStd::IsEOF ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

Definition at line 166 of file BmnFileReaderZStd.cxx.

References fArchiveReadManager.

Referenced by IsEOF(), and operator=().

Here is the caller graph for this function:

◆ IsEOF() [2/2]

virtual bool BmnFileReaderZStd::IsEOF ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

References IsEOF().

Here is the call graph for this function:

◆ IsGood() [1/2]

bool BmnFileReaderZStd::IsGood ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

Definition at line 157 of file BmnFileReaderZStd.cxx.

References fArchiveReadManager, fLastReadReturnValue, and fZstdStream.

Referenced by IsGood(), and operator=().

Here is the caller graph for this function:

◆ IsGood() [2/2]

virtual bool BmnFileReaderZStd::IsGood ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

References IsGood().

Here is the call graph for this function:

◆ IsOpen() [1/2]

bool BmnFileReaderZStd::IsOpen ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

Definition at line 178 of file BmnFileReaderZStd.cxx.

References fArchiveReadManager, and fZstdStream.

Referenced by IsOpen(), and operator=().

Here is the caller graph for this function:

◆ IsOpen() [2/2]

virtual bool BmnFileReaderZStd::IsOpen ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

References IsOpen().

Here is the call graph for this function:

◆ IsStreamInGoodState() [1/2]

bool BmnFileReaderZStd::IsStreamInGoodState ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

Definition at line 259 of file BmnFileReaderZStd.cxx.

References fLastReadReturnValue.

Referenced by IsStreamInGoodState(), and operator=().

Here is the caller graph for this function:

◆ IsStreamInGoodState() [2/2]

virtual bool BmnFileReaderZStd::IsStreamInGoodState ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

References IsStreamInGoodState().

Here is the call graph for this function:

◆ JumpsAllowed() [1/2]

bool BmnFileReaderZStd::JumpsAllowed ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

Definition at line 225 of file BmnFileReaderZStd.cxx.

Referenced by JumpsAllowed(), and operator=().

Here is the caller graph for this function:

◆ JumpsAllowed() [2/2]

virtual bool BmnFileReaderZStd::JumpsAllowed ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

References JumpsAllowed().

Here is the call graph for this function:

◆ JumpTo() [1/2]

void BmnFileReaderZStd::JumpTo ( size_t )

overridevirtual

Implements BmnIArchiveLibRead.

Definition at line 230 of file BmnFileReaderZStd.cxx.

Referenced by JumpTo(), and operator=().

Here is the caller graph for this function:

◆ JumpTo() [2/2]

virtual void BmnFileReaderZStd::JumpTo ( size_t )

overridevirtual

Implements BmnIArchiveLibRead.

References JumpTo().

Here is the call graph for this function:

◆ Open() [1/2]

void BmnFileReaderZStd::Open ( const BmnBinaryFileProcessingOptions processingFlags = BmnBinaryFileProcessingOptions::ReadBinary )

overridevirtual

Implements BmnIFileReader.

Definition at line 69 of file BmnFileReaderZStd.cxx.

References fArchiveReadManager, BmnIFileReader::fFilePath, fZstdStream, and BmnIFileReader::PerformStandardChecksBeforeOpening().

Referenced by Open(), operator=(), and Seek().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Open() [2/2]

virtual void BmnFileReaderZStd::Open ( const BmnBinaryFileProcessingOptions processingFlags = BmnBinaryFileProcessingOptions::ReadBinary )

overridevirtual

Implements BmnIFileReader.

References Open().

Here is the call graph for this function:

◆ operator=() [1/4]

BmnFileReaderZStd & BmnFileReaderZStd::operator= ( BmnFileReaderZStd && )

deletenoexcept

References BmnFileReaderZStd(), ClearStateFlags(), Close(), GetLastReadReturnValue(), GetLastUncompressErrorDescription(), GetNumberOfDecompressedBytes(), GetUnderlyingLibraryHandler(), HasReachedTheEndOfStream(), IsEOF(), IsGood(), IsOpen(), IsStreamInGoodState(), JumpsAllowed(), JumpTo(), Open(), Read(), Seek(), Tell(), and Uncompress().

Here is the call graph for this function:

◆ operator=() [2/4]

BmnFileReaderZStd & BmnFileReaderZStd::operator= ( BmnFileReaderZStd && )

deletenoexcept

References BmnFileReaderZStd().

Here is the call graph for this function:

◆ operator=() [3/4]

BmnFileReaderZStd & BmnFileReaderZStd::operator= ( const BmnFileReaderZStd & )

delete

References BmnFileReaderZStd().

Here is the call graph for this function:

◆ operator=() [4/4]

BmnFileReaderZStd & BmnFileReaderZStd::operator= ( const BmnFileReaderZStd & )

delete

References BmnFileReaderZStd().

Here is the call graph for this function:

◆ Read() [1/2]

int64_t BmnFileReaderZStd::Read	(	void *	dataToFill,
		const int64_t	sizeToFill )

overridevirtual

Implements BmnIFileReader.

Definition at line 112 of file BmnFileReaderZStd.cxx.

References fArchiveReadManager, and fLastReadReturnValue.

Referenced by operator=(), and Read().

Here is the caller graph for this function:

◆ Read() [2/2]

virtual int64_t BmnFileReaderZStd::Read	(	void *	dataToFill,
		const int64_t	sizeToFill )

overridevirtual

Implements BmnIFileReader.

References Read().

Here is the call graph for this function:

◆ Seek() [1/2]

void BmnFileReaderZStd::Seek ( int64_t value )

overridevirtual

Implements BmnIFileReader.

Definition at line 129 of file BmnFileReaderZStd.cxx.

References Close(), fArchiveReadManager, fLastReadReturnValue, fNumberOfReadBytes, fZstdStream, Open(), and ReadBinary.

Referenced by operator=(), and Seek().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Seek() [2/2]

virtual void BmnFileReaderZStd::Seek ( int64_t value )

overridevirtual

Implements BmnIFileReader.

References Seek().

Here is the call graph for this function:

◆ Tell() [1/2]

int64_t BmnFileReaderZStd::Tell ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

Definition at line 123 of file BmnFileReaderZStd.cxx.

References fArchiveReadManager, and fNumberOfReadBytes.

Referenced by operator=(), and Tell().

Here is the caller graph for this function:

◆ Tell() [2/2]

virtual int64_t BmnFileReaderZStd::Tell ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

References Tell().

Here is the call graph for this function:

◆ Uncompress() [1/2]

BmnFileStreamResults BmnFileReaderZStd::Uncompress	(	const void *	source,
		const size_t	sourceTotalSize,
		size_t &	numberOfReadBytes,
		void *	output,
		const size_t	outputTotalSize,
		size_t &	numberOfSetOutputBytes )

overridevirtual

Implements BmnIArchiveLibRead.

Definition at line 185 of file BmnFileReaderZStd.cxx.

References FileNotOpen, fLastReadReturnValue, fNumberOfReadBytes, fZstdStream, ReachedEOF, Success, TryingToReadBadStream, and UnexpectedFail.

Referenced by operator=(), and Uncompress().

Here is the caller graph for this function:

◆ Uncompress() [2/2]

virtual BmnFileStreamResults BmnFileReaderZStd::Uncompress	(	const void *	source,
		const size_t	sourceTotalSize,
		size_t &	numberOfReadBytes,
		void *	output,
		const size_t	outputTotalSize,
		size_t &	numberOfSetOutputBytes )

overridevirtual

Implements BmnIArchiveLibRead.

References Uncompress().

Here is the call graph for this function:

Member Data Documentation

◆ fArchiveReadManager

BmnReaderCacheManager< 32ull *1024ull, 64ull *1024ull > BmnFileReaderZStd::fArchiveReadManager

private

Definition at line 208 of file BmnFileReaderZStd.h.

Referenced by BmnFileReaderZStd(), BmnFileReaderZStd(), BmnFileReaderZStd(), BmnFileReaderZStd(), ClearStateFlags(), Close(), GetLastReadReturnValue(), IsEOF(), IsGood(), IsOpen(), Open(), Read(), Seek(), and Tell().

◆ fLastReadReturnValue

size_t BmnFileReaderZStd::fLastReadReturnValue

private

Definition at line 210 of file BmnFileReaderZStd.h.

Referenced by BmnFileReaderZStd(), BmnFileReaderZStd(), BmnFileReaderZStd(), BmnFileReaderZStd(), ClearStateFlags(), Close(), GetLastReadReturnValue(), GetLastUncompressErrorDescription(), HasReachedTheEndOfStream(), IsGood(), IsStreamInGoodState(), Read(), Seek(), and Uncompress().

◆ fNumberOfReadBytes

size_t BmnFileReaderZStd::fNumberOfReadBytes

private

Definition at line 209 of file BmnFileReaderZStd.h.

Referenced by BmnFileReaderZStd(), BmnFileReaderZStd(), BmnFileReaderZStd(), BmnFileReaderZStd(), Close(), GetLastReadReturnValue(), GetNumberOfDecompressedBytes(), Seek(), Tell(), and Uncompress().

◆ fZstdStream

ZSTD_DCtx_s * BmnFileReaderZStd::fZstdStream

private

Definition at line 207 of file BmnFileReaderZStd.h.

Referenced by BmnFileReaderZStd(), BmnFileReaderZStd(), BmnFileReaderZStd(), BmnFileReaderZStd(), Close(), GetLastReadReturnValue(), GetUnderlyingLibraryHandler(), IsGood(), IsOpen(), Open(), Seek(), and Uncompress().

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

compression/include/BmnFileReaderZStd.h
install/include/BmnFileReaderZStd.h
compression/sources/BmnFileReaderZStd.cxx

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BmnFileReaderZStd() [1/12]

◆ BmnFileReaderZStd() [2/12]

◆ BmnFileReaderZStd() [3/12]

◆ BmnFileReaderZStd() [4/12]

◆ ~BmnFileReaderZStd() [1/2]

◆ BmnFileReaderZStd() [5/12]

◆ BmnFileReaderZStd() [6/12]

◆ BmnFileReaderZStd() [7/12]

◆ BmnFileReaderZStd() [8/12]

◆ BmnFileReaderZStd() [9/12]

◆ BmnFileReaderZStd() [10/12]

◆ ~BmnFileReaderZStd() [2/2]

◆ BmnFileReaderZStd() [11/12]

◆ BmnFileReaderZStd() [12/12]

Member Function Documentation

◆ ClearStateFlags() [1/2]

◆ ClearStateFlags() [2/2]

◆ Close() [1/2]

◆ Close() [2/2]

◆ GetLastReadReturnValue() [1/2]

◆ GetLastReadReturnValue() [2/2]

◆ GetLastUncompressErrorDescription() [1/2]

◆ GetLastUncompressErrorDescription() [2/2]

◆ GetNumberOfDecompressedBytes() [1/2]

◆ GetNumberOfDecompressedBytes() [2/2]

◆ GetUnderlyingLibraryHandler() [1/2]

◆ GetUnderlyingLibraryHandler() [2/2]

◆ HasReachedTheEndOfStream() [1/2]

◆ HasReachedTheEndOfStream() [2/2]

◆ IsEOF() [1/2]

◆ IsEOF() [2/2]

◆ IsGood() [1/2]

◆ IsGood() [2/2]

◆ IsOpen() [1/2]

◆ IsOpen() [2/2]

◆ IsStreamInGoodState() [1/2]

◆ IsStreamInGoodState() [2/2]

◆ JumpsAllowed() [1/2]

◆ JumpsAllowed() [2/2]

◆ JumpTo() [1/2]

◆ JumpTo() [2/2]

◆ Open() [1/2]

◆ Open() [2/2]

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ Read() [1/2]

◆ Read() [2/2]

◆ Seek() [1/2]

◆ Seek() [2/2]

◆ Tell() [1/2]

◆ Tell() [2/2]

◆ Uncompress() [1/2]

◆ Uncompress() [2/2]

Member Data Documentation

◆ fArchiveReadManager

◆ fLastReadReturnValue

◆ fNumberOfReadBytes

◆ fZstdStream