Base Framework
Public Member Functions | List of all members
Inflater Class Referenceabstract

Inflater push stream interface. More...

#include <base/compression/Inflater.h>

Inherits PushInterface, and PullInterface.

Inherited by BZip2Inflater [virtual], and ZLibInflater [virtual].

Public Member Functions

virtual bool atEnd () const noexcept=0
 
- Public Member Functions inherited from PushInterface
virtual void flush ()
 
virtual bool pushBegin (uint64 totalSize)
 
virtual MemorySize push (const uint8 *buffer, MemorySize size)=0
 
virtual void pushEnd ()
 
- Public Member Functions inherited from PullInterface
virtual MemorySize pull (uint8 *buffer, MemorySize size)=0
 

Detailed Description

Inflater push stream interface.

Interface implemented by decompression classes. The compressed and decompressed data is pushed onto and pulled from the stream, respectively. push() may be invoked in the initial mode of the inflation stream unless noted otherwise.

Version
1.0

Member Function Documentation

◆ atEnd()

virtual bool Inflater::atEnd ( ) const
pure virtualnoexcept

Returns true if the end has been reached (no more decompressed data may be pulled from the stream). This always returns false until pushEnd() has been invoked.

Implemented in BZip2Inflater, and ZLibInflater.