Botan::Compression_Stream Class Reference

#include <compression.h>

Inheritance diagram for Botan::Compression_Stream:

Public Member Functions
virtual size_t	avail_in () const =0
virtual size_t	avail_out () const =0
virtual uint32_t	finish_flag () const =0
virtual uint32_t	flush_flag () const =0
virtual void	next_in (uint8_t *b, size_t len)=0
virtual void	next_out (uint8_t *b, size_t len)=0
virtual bool	run (uint32_t flags)=0
virtual uint32_t	run_flag () const =0
virtual	~Compression_Stream ()=default

Detailed Description

Adapts a zlib style API

Definition at line 209 of file compression.h.

Constructor & Destructor Documentation

~Compression_Stream()

virtual Botan::Compression_Stream::~Compression_Stream ( )

virtualdefault

Member Function Documentation

avail_in()

virtual size_t Botan::Compression_Stream::avail_in ( ) const

pure virtual

Return how much input remains unconsumed

Returns

the number of unread input bytes

Implemented in Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >.

avail_out()

virtual size_t Botan::Compression_Stream::avail_out ( ) const

pure virtual

Return how much output space remains

Returns

the number of unwritten output bytes

Implemented in Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >.

finish_flag()

virtual uint32_t Botan::Compression_Stream::finish_flag ( ) const

pure virtual

Return the library specific flag for finishing the stream

Returns

the finish flag

flush_flag()

virtual uint32_t Botan::Compression_Stream::flush_flag ( ) const

pure virtual

Return the library specific flag for flushing the stream

Returns

the flush flag

next_in()

virtual void Botan::Compression_Stream::next_in ( uint8_t * b, size_t len )

pure virtual

Set the input buffer

Parameters

b	the input buffer
len	the length of b in bytes

Implemented in Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >.

next_out()

virtual void Botan::Compression_Stream::next_out ( uint8_t * b, size_t len )

pure virtual

Set the output buffer

Parameters

b	the output buffer
len	the length of b in bytes

Implemented in Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >.

run()

virtual bool Botan::Compression_Stream::run ( uint32_t flags )

pure virtual

Run the compression engine over the current buffers

Parameters

flags

one of run_flag(), flush_flag() or finish_flag()

Returns

true once the stream is complete

run_flag()

virtual uint32_t Botan::Compression_Stream::run_flag ( ) const

pure virtual

Return the library specific flag for ordinary processing

Returns

the run flag

---

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

• src/lib/compression/compression.h