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

Deflater push stream interface. More...

#include <base/compression/Deflater.h>

Inherits PushInterface, and PullInterface.

Inherited by BZip2Deflater [virtual], and ZLibDeflater [virtual].

Public Member Functions

virtual bool atEnd () const =0
 
virtual void flush ()=0
 
- Public Member Functions inherited from PushInterface
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

Deflater push stream interface.

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

Version
1.0

Member Function Documentation

◆ atEnd()

virtual bool Deflater::atEnd ( ) const
pure virtual

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

Implemented in BZip2Deflater, and ZLibDeflater.

◆ flush()

virtual void Deflater::flush ( )
pure virtual

Flushes any uncompressed data onto the stream. The stream has been flushed when pull() returns 0. One or more invocations of pull() is required. push() may only be invoked hereafter.

Reimplemented from PushInterface.

Implemented in BZip2Deflater, and ZLibDeflater.