#include <BmnFileReaderZLib.h>

Inheritance diagram for BmnFileReaderZLib:

Collaboration diagram for BmnFileReaderZLib:

Public Member Functions
	BmnFileReaderZLib (const std::string &fileName="")
	BmnFileReaderZLib (std::string &&fileName)
	BmnFileReaderZLib (const std::filesystem::path &filePath)
	BmnFileReaderZLib (std::filesystem::path &&filePath)
virtual	~BmnFileReaderZLib () override
	BmnFileReaderZLib (const BmnFileReaderZLib &)=delete
BmnFileReaderZLib &	operator= (const BmnFileReaderZLib &)=delete
	BmnFileReaderZLib (BmnFileReaderZLib &&) noexcept=delete
BmnFileReaderZLib &	operator= (BmnFileReaderZLib &&) 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
z_stream_s *	GetUnderlyingLibraryStream () const noexcept
	BmnFileReaderZLib (const std::string &fileName="")
	BmnFileReaderZLib (std::string &&fileName)
	BmnFileReaderZLib (const std::filesystem::path &filePath)
	BmnFileReaderZLib (std::filesystem::path &&filePath)
virtual	~BmnFileReaderZLib () override
	BmnFileReaderZLib (const BmnFileReaderZLib &)=delete
BmnFileReaderZLib &	operator= (const BmnFileReaderZLib &)=delete
	BmnFileReaderZLib (BmnFileReaderZLib &&) noexcept=delete
BmnFileReaderZLib &	operator= (BmnFileReaderZLib &&) 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
z_stream_s *	GetUnderlyingLibraryStream () 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
z_stream_s *	fZlibStream
BmnReaderCacheManager< 32ull 1024ull, 64ull 1024ull >	fArchiveReadManager
size_t	fNumberOfReadBytes
int32_t	fLastReturnStatus

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 22 of file BmnFileReaderZLib.h.

Constructor & Destructor Documentation

◆ BmnFileReaderZLib() [1/12]

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

explicit

Definition at line 23 of file BmnFileReaderZLib.cxx.

References BmnIFileReader::BmnIFileReader(), fArchiveReadManager, fLastReturnStatus, fNumberOfReadBytes, and fZlibStream.

Referenced by BmnFileReaderZLib(), BmnFileReaderZLib(), GetUnderlyingLibraryStream(), operator=(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BmnFileReaderZLib() [2/12]

BmnFileReaderZLib::BmnFileReaderZLib ( std::string && fileName )

explicit

Definition at line 31 of file BmnFileReaderZLib.cxx.

References BmnIFileReader::BmnIFileReader(), fArchiveReadManager, fLastReturnStatus, fNumberOfReadBytes, and fZlibStream.

Here is the call graph for this function:

◆ BmnFileReaderZLib() [3/12]

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

explicit

Definition at line 39 of file BmnFileReaderZLib.cxx.

References BmnIFileReader::BmnIFileReader(), fArchiveReadManager, fLastReturnStatus, fNumberOfReadBytes, and fZlibStream.

Here is the call graph for this function:

◆ BmnFileReaderZLib() [4/12]

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

explicit

Definition at line 47 of file BmnFileReaderZLib.cxx.

References BmnIFileReader::BmnIFileReader(), fArchiveReadManager, fLastReturnStatus, fNumberOfReadBytes, and fZlibStream.

Here is the call graph for this function:

◆ ~BmnFileReaderZLib() [1/2]

BmnFileReaderZLib::~BmnFileReaderZLib ( )

overridevirtual

Definition at line 55 of file BmnFileReaderZLib.cxx.

References Close(), and fZlibStream.

Here is the call graph for this function:

◆ BmnFileReaderZLib() [5/12]

BmnFileReaderZLib::BmnFileReaderZLib ( const BmnFileReaderZLib & )

delete

References BmnFileReaderZLib().

Here is the call graph for this function:

◆ BmnFileReaderZLib() [6/12]

BmnFileReaderZLib::BmnFileReaderZLib ( BmnFileReaderZLib && )

deletenoexcept

References BmnFileReaderZLib().

Here is the call graph for this function:

◆ BmnFileReaderZLib() [7/12]

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

explicit

◆ BmnFileReaderZLib() [8/12]

BmnFileReaderZLib::BmnFileReaderZLib ( std::string && fileName )

explicit

◆ BmnFileReaderZLib() [9/12]

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

explicit

◆ BmnFileReaderZLib() [10/12]

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

explicit

◆ ~BmnFileReaderZLib() [2/2]

virtual BmnFileReaderZLib::~BmnFileReaderZLib ( )

overridevirtual

◆ BmnFileReaderZLib() [11/12]

BmnFileReaderZLib::BmnFileReaderZLib ( const BmnFileReaderZLib & )

delete

References BmnFileReaderZLib().

Here is the call graph for this function:

◆ BmnFileReaderZLib() [12/12]

BmnFileReaderZLib::BmnFileReaderZLib ( BmnFileReaderZLib && )

deletenoexcept

References BmnFileReaderZLib().

Here is the call graph for this function:

Member Function Documentation

◆ ClearStateFlags() [1/2]

void BmnFileReaderZLib::ClearStateFlags ( )

overridevirtual

Implements BmnIFileReader.

Definition at line 172 of file BmnFileReaderZLib.cxx.

References fArchiveReadManager, and fLastReturnStatus.

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

Here is the caller graph for this function:

◆ ClearStateFlags() [2/2]

virtual void BmnFileReaderZLib::ClearStateFlags ( )

overridevirtual

Implements BmnIFileReader.

References ClearStateFlags().

Here is the call graph for this function:

◆ Close() [1/2]

void BmnFileReaderZLib::Close ( )

overridevirtualnoexcept

Implements BmnIFileReader.

Definition at line 95 of file BmnFileReaderZLib.cxx.

References fArchiveReadManager, fLastReturnStatus, fNumberOfReadBytes, and fZlibStream.

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

Here is the caller graph for this function:

◆ Close() [2/2]

virtual void BmnFileReaderZLib::Close ( )

overridevirtualnoexcept

Implements BmnIFileReader.

References Close().

Here is the call graph for this function:

◆ GetLastUncompressErrorDescription() [1/2]

std::string BmnFileReaderZLib::GetLastUncompressErrorDescription ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

Definition at line 218 of file BmnFileReaderZLib.cxx.

References fZlibStream.

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

Here is the caller graph for this function:

◆ GetLastUncompressErrorDescription() [2/2]

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

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

References GetLastUncompressErrorDescription().

Here is the call graph for this function:

◆ GetNumberOfDecompressedBytes() [1/2]

size_t BmnFileReaderZLib::GetNumberOfDecompressedBytes ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

Definition at line 246 of file BmnFileReaderZLib.cxx.

References fNumberOfReadBytes.

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

Here is the caller graph for this function:

◆ GetNumberOfDecompressedBytes() [2/2]

virtual size_t BmnFileReaderZLib::GetNumberOfDecompressedBytes ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

References GetNumberOfDecompressedBytes().

Here is the call graph for this function:

◆ GetUnderlyingLibraryStream() [1/2]

z_stream_s * BmnFileReaderZLib::GetUnderlyingLibraryStream ( ) const

inlinenodiscardnoexcept

Definition at line 215 of file BmnFileReaderZLib.h.

References BmnFileReaderZLib(), fZlibStream, and GetUnderlyingLibraryStream().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUnderlyingLibraryStream() [2/2]

z_stream_s * BmnFileReaderZLib::GetUnderlyingLibraryStream ( ) const

inlinenodiscardnoexcept

References BmnFileReaderZLib(), fArchiveReadManager, fLastReturnStatus, fNumberOfReadBytes, fZlibStream, and GetUnderlyingLibraryStream().

Here is the call graph for this function:

◆ HasReachedTheEndOfStream() [1/2]

bool BmnFileReaderZLib::HasReachedTheEndOfStream ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

Definition at line 251 of file BmnFileReaderZLib.cxx.

References fLastReturnStatus, and IsStreamInGoodState().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasReachedTheEndOfStream() [2/2]

virtual bool BmnFileReaderZLib::HasReachedTheEndOfStream ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

References HasReachedTheEndOfStream().

Here is the call graph for this function:

◆ IsEOF() [1/2]

bool BmnFileReaderZLib::IsEOF ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

Definition at line 167 of file BmnFileReaderZLib.cxx.

References fArchiveReadManager.

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

Here is the caller graph for this function:

◆ IsEOF() [2/2]

virtual bool BmnFileReaderZLib::IsEOF ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

References IsEOF().

Here is the call graph for this function:

◆ IsGood() [1/2]

bool BmnFileReaderZLib::IsGood ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

Definition at line 158 of file BmnFileReaderZLib.cxx.

References fArchiveReadManager, fZlibStream, and IsStreamInGoodState().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsGood() [2/2]

virtual bool BmnFileReaderZLib::IsGood ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

References IsGood().

Here is the call graph for this function:

◆ IsOpen() [1/2]

bool BmnFileReaderZLib::IsOpen ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

Definition at line 179 of file BmnFileReaderZLib.cxx.

References fArchiveReadManager, and fZlibStream.

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

Here is the caller graph for this function:

◆ IsOpen() [2/2]

virtual bool BmnFileReaderZLib::IsOpen ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

References IsOpen().

Here is the call graph for this function:

◆ IsStreamInGoodState() [1/2]

bool BmnFileReaderZLib::IsStreamInGoodState ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

Definition at line 262 of file BmnFileReaderZLib.cxx.

References fLastReturnStatus.

Referenced by HasReachedTheEndOfStream(), IsGood(), IsStreamInGoodState(), operator=(), Read(), Seek(), and Uncompress().

Here is the caller graph for this function:

◆ IsStreamInGoodState() [2/2]

virtual bool BmnFileReaderZLib::IsStreamInGoodState ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

References IsStreamInGoodState().

Here is the call graph for this function:

◆ JumpsAllowed() [1/2]

bool BmnFileReaderZLib::JumpsAllowed ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

Definition at line 230 of file BmnFileReaderZLib.cxx.

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

Here is the caller graph for this function:

◆ JumpsAllowed() [2/2]

virtual bool BmnFileReaderZLib::JumpsAllowed ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIArchiveLibRead.

References JumpsAllowed().

Here is the call graph for this function:

◆ JumpTo() [1/2]

void BmnFileReaderZLib::JumpTo ( size_t )

overridevirtual

Implements BmnIArchiveLibRead.

Definition at line 235 of file BmnFileReaderZLib.cxx.

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

Here is the caller graph for this function:

◆ JumpTo() [2/2]

virtual void BmnFileReaderZLib::JumpTo ( size_t )

overridevirtual

Implements BmnIArchiveLibRead.

References JumpTo().

Here is the call graph for this function:

◆ Open() [1/2]

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

overridevirtual

Implements BmnIFileReader.

Definition at line 64 of file BmnFileReaderZLib.cxx.

References fArchiveReadManager, BmnIFileReader::fFilePath, fZlibStream, 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 BmnFileReaderZLib::Open ( const BmnBinaryFileProcessingOptions processingFlags = BmnBinaryFileProcessingOptions::ReadBinary )

overridevirtual

Implements BmnIFileReader.

References Open().

Here is the call graph for this function:

◆ operator=() [1/4]

BmnFileReaderZLib & BmnFileReaderZLib::operator= ( BmnFileReaderZLib && )

deletenoexcept

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

Here is the call graph for this function:

◆ operator=() [2/4]

BmnFileReaderZLib & BmnFileReaderZLib::operator= ( BmnFileReaderZLib && )

deletenoexcept

References BmnFileReaderZLib().

Here is the call graph for this function:

◆ operator=() [3/4]

BmnFileReaderZLib & BmnFileReaderZLib::operator= ( const BmnFileReaderZLib & )

delete

References BmnFileReaderZLib().

Here is the call graph for this function:

◆ operator=() [4/4]

BmnFileReaderZLib & BmnFileReaderZLib::operator= ( const BmnFileReaderZLib & )

delete

References BmnFileReaderZLib().

Here is the call graph for this function:

◆ Read() [1/2]

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

overridevirtual

Implements BmnIFileReader.

Definition at line 113 of file BmnFileReaderZLib.cxx.

References fArchiveReadManager, and IsStreamInGoodState().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Read() [2/2]

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

overridevirtual

Implements BmnIFileReader.

References Read().

Here is the call graph for this function:

◆ Seek() [1/2]

void BmnFileReaderZLib::Seek ( int64_t value )

overridevirtual

Implements BmnIFileReader.

Definition at line 130 of file BmnFileReaderZLib.cxx.

References Close(), fArchiveReadManager, fNumberOfReadBytes, fZlibStream, IsStreamInGoodState(), 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 BmnFileReaderZLib::Seek ( int64_t value )

overridevirtual

Implements BmnIFileReader.

References Seek().

Here is the call graph for this function:

◆ Tell() [1/2]

int64_t BmnFileReaderZLib::Tell ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

Definition at line 124 of file BmnFileReaderZLib.cxx.

References fArchiveReadManager, and fNumberOfReadBytes.

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

Here is the caller graph for this function:

◆ Tell() [2/2]

virtual int64_t BmnFileReaderZLib::Tell ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

References Tell().

Here is the call graph for this function:

◆ Uncompress() [1/2]

BmnFileStreamResults BmnFileReaderZLib::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 186 of file BmnFileReaderZLib.cxx.

References FileNotOpen, fLastReturnStatus, fNumberOfReadBytes, fZlibStream, IsStreamInGoodState(), ReachedEOF, Success, TryingToReadBadStream, and UnexpectedFail.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Uncompress() [2/2]

virtual BmnFileStreamResults BmnFileReaderZLib::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 > BmnFileReaderZLib::fArchiveReadManager

private

Definition at line 205 of file BmnFileReaderZLib.h.

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

◆ fLastReturnStatus

int32_t BmnFileReaderZLib::fLastReturnStatus

private

Definition at line 207 of file BmnFileReaderZLib.h.

Referenced by BmnFileReaderZLib(), BmnFileReaderZLib(), BmnFileReaderZLib(), BmnFileReaderZLib(), ClearStateFlags(), Close(), GetUnderlyingLibraryStream(), HasReachedTheEndOfStream(), IsStreamInGoodState(), and Uncompress().

◆ fNumberOfReadBytes

size_t BmnFileReaderZLib::fNumberOfReadBytes

private

Definition at line 206 of file BmnFileReaderZLib.h.

Referenced by BmnFileReaderZLib(), BmnFileReaderZLib(), BmnFileReaderZLib(), BmnFileReaderZLib(), Close(), GetNumberOfDecompressedBytes(), GetUnderlyingLibraryStream(), Seek(), Tell(), and Uncompress().

◆ fZlibStream

z_stream_s * BmnFileReaderZLib::fZlibStream

private

Definition at line 204 of file BmnFileReaderZLib.h.

Referenced by BmnFileReaderZLib(), BmnFileReaderZLib(), BmnFileReaderZLib(), BmnFileReaderZLib(), ~BmnFileReaderZLib(), Close(), GetLastUncompressErrorDescription(), GetUnderlyingLibraryStream(), IsGood(), IsOpen(), Open(), Seek(), and Uncompress().

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

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BmnFileReaderZLib() [1/12]

◆ BmnFileReaderZLib() [2/12]

◆ BmnFileReaderZLib() [3/12]

◆ BmnFileReaderZLib() [4/12]

◆ ~BmnFileReaderZLib() [1/2]

◆ BmnFileReaderZLib() [5/12]

◆ BmnFileReaderZLib() [6/12]

◆ BmnFileReaderZLib() [7/12]

◆ BmnFileReaderZLib() [8/12]

◆ BmnFileReaderZLib() [9/12]

◆ BmnFileReaderZLib() [10/12]

◆ ~BmnFileReaderZLib() [2/2]

◆ BmnFileReaderZLib() [11/12]

◆ BmnFileReaderZLib() [12/12]

Member Function Documentation

◆ ClearStateFlags() [1/2]

◆ ClearStateFlags() [2/2]

◆ Close() [1/2]

◆ Close() [2/2]

◆ GetLastUncompressErrorDescription() [1/2]

◆ GetLastUncompressErrorDescription() [2/2]

◆ GetNumberOfDecompressedBytes() [1/2]

◆ GetNumberOfDecompressedBytes() [2/2]

◆ GetUnderlyingLibraryStream() [1/2]

◆ GetUnderlyingLibraryStream() [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

◆ fLastReturnStatus

◆ fNumberOfReadBytes

◆ fZlibStream