Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType > Class Template Reference

#include <compress_utils.h>

Inheritance diagram for Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >:

Public Member Functions
size_t	avail_in () const override
size_t	avail_out () const override
virtual uint32_t	finish_flag () const =0
virtual uint32_t	flush_flag () const =0
void	next_in (uint8_t *b, size_t len) override
void	next_out (uint8_t *b, size_t len) override
Zlib_Style_Stream &	operator= (const Zlib_Style_Stream &other)=delete
Zlib_Style_Stream &	operator= (Zlib_Style_Stream &&other)=delete
virtual bool	run (uint32_t flags)=0
virtual uint32_t	run_flag () const =0
	Zlib_Style_Stream ()
	Zlib_Style_Stream (const Zlib_Style_Stream &other)=delete
	Zlib_Style_Stream (Zlib_Style_Stream &&other)=delete
	~Zlib_Style_Stream () override

Protected Types
typedef Stream	stream_t

Protected Member Functions
Compression_Alloc_Info *	alloc ()
stream_t *	streamp ()

Detailed Description

template<typename Stream, typename ByteType, typename StreamLenType = size_t>
class Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >

Wrapper for Zlib/Bzlib/LZMA stream types

Definition at line 44 of file compress_utils.h.

Member Typedef Documentation

stream_t

template<typename Stream, typename ByteType, typename StreamLenType = size_t>

typedef Stream Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >::stream_t

protected

Definition at line 76 of file compress_utils.h.

Constructor & Destructor Documentation

Zlib_Style_Stream() [1/3]

template<typename Stream, typename ByteType, typename StreamLenType = size_t>

Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >::Zlib_Style_Stream ( )

inline

Definition at line 66 of file compress_utils.h.

: m_allocs(std::make_unique<Compression_Alloc_Info>()) { clear_mem(&m_stream, 1); }

References Botan::clear_mem().

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

Zlib_Style_Stream() [2/3]

template<typename Stream, typename ByteType, typename StreamLenType = size_t>

Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >::Zlib_Style_Stream ( const Zlib_Style_Stream< Stream, ByteType, StreamLenType > & other )

delete

References Zlib_Style_Stream().

Zlib_Style_Stream() [3/3]

template<typename Stream, typename ByteType, typename StreamLenType = size_t>

Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >::Zlib_Style_Stream ( Zlib_Style_Stream< Stream, ByteType, StreamLenType > && other )

delete

References Zlib_Style_Stream().

~Zlib_Style_Stream()

template<typename Stream, typename ByteType, typename StreamLenType = size_t>

Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >::~Zlib_Style_Stream ( )

inlineoverride

Definition at line 73 of file compress_utils.h.

{ clear_mem(&m_stream, 1); }

References Botan::clear_mem().

Member Function Documentation

alloc()

template<typename Stream, typename ByteType, typename StreamLenType = size_t>

Compression_Alloc_Info * Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >::alloc ( )

inlineprotected

Definition at line 80 of file compress_utils.h.

{ return m_allocs.get(); }

avail_in()

template<typename Stream, typename ByteType, typename StreamLenType = size_t>

size_t Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >::avail_in ( ) const

inlineoverridevirtual

Return how much input remains unconsumed

Returns

the number of unread input bytes

Implements Botan::Compression_Stream.

Definition at line 62 of file compress_utils.h.

{ return m_stream.avail_in; }

avail_out()

template<typename Stream, typename ByteType, typename StreamLenType = size_t>

size_t Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >::avail_out ( ) const

inlineoverridevirtual

Return how much output space remains

Returns

the number of unwritten output bytes

Implements Botan::Compression_Stream.

Definition at line 64 of file compress_utils.h.

{ return m_stream.avail_out; }

finish_flag()

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

pure virtualinherited

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 virtualinherited

Return the library specific flag for flushing the stream

Returns

the flush flag

next_in()

template<typename Stream, typename ByteType, typename StreamLenType = size_t>

void Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >::next_in ( uint8_t * b, size_t len )

inlineoverridevirtual

Set the input buffer

Parameters

b	the input buffer
len	the length of b in bytes

Implements Botan::Compression_Stream.

Definition at line 46 of file compress_utils.h.

                                                    {
         if(len > std::numeric_limits<StreamLenType>::max()) {
            throw Not_Implemented("Compression chunk is too large for this backend's length field");
         }
         m_stream.next_in = reinterpret_cast<ByteType*>(b);
         m_stream.avail_in = static_cast<StreamLenType>(len);
      }

next_out()

template<typename Stream, typename ByteType, typename StreamLenType = size_t>

void Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >::next_out ( uint8_t * b, size_t len )

inlineoverridevirtual

Set the output buffer

Parameters

b	the output buffer
len	the length of b in bytes

Implements Botan::Compression_Stream.

Definition at line 54 of file compress_utils.h.

                                                     {
         if(len > std::numeric_limits<StreamLenType>::max()) {
            throw Not_Implemented("Compression chunk is too large for this backend's length field");
         }
         m_stream.next_out = reinterpret_cast<ByteType*>(b);
         m_stream.avail_out = static_cast<StreamLenType>(len);
      }

operator=() [1/2]

template<typename Stream, typename ByteType, typename StreamLenType = size_t>

Zlib_Style_Stream & Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >::operator= ( const Zlib_Style_Stream< Stream, ByteType, StreamLenType > & other )

delete

References Zlib_Style_Stream().

operator=() [2/2]

template<typename Stream, typename ByteType, typename StreamLenType = size_t>

Zlib_Style_Stream & Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >::operator= ( Zlib_Style_Stream< Stream, ByteType, StreamLenType > && other )

delete

References Zlib_Style_Stream().

run()

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

pure virtualinherited

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 virtualinherited

Return the library specific flag for ordinary processing

Returns

the run flag

streamp()

template<typename Stream, typename ByteType, typename StreamLenType = size_t>

stream_t * Botan::Zlib_Style_Stream< Stream, ByteType, StreamLenType >::streamp ( )

inlineprotected

Definition at line 78 of file compress_utils.h.

{ return &m_stream; }

---

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

• src/lib/compression/compress_utils.h