Botan::Stream_Decompression Class Reference

#include <compression.h>

Inheritance diagram for Botan::Stream_Decompression:

Public Member Functions
void	clear () finaloverride
void	finish (secure_vector< uint8_t > &buf, size_t offset) finaloverride
virtual std::string	name () const =0
void	update (secure_vector< uint8_t > &buf, size_t offset) finaloverride

Detailed Description

FIXME add doc

Definition at line 155 of file compression.h.

Member Function Documentation

void Botan::Stream_Decompression::clear ( )

finaloverridevirtual

Reset the state and abort the current message; start can be called again to process a new message.

Implements Botan::Decompression_Algorithm.

Definition at line 118 of file compress_utils.cpp.

   {
   m_stream.reset();
   }

void Botan::Stream_Decompression::finish ( secure_vector< uint8_t > &  final_block, size_t  offset  )

finaloverridevirtual

Finish decompressing

Parameters

final_block	in/out parameter
offset	an offset into final_block to begin processing

Implements Botan::Decompression_Algorithm.

Definition at line 180 of file compress_utils.cpp.

References Botan::Decompression_Algorithm::name().

   {
   if(buf.size() != offset || m_stream.get())
      process(buf, offset, m_stream->finish_flag());

   if(m_stream.get())
      throw Exception(name() + " finished but not at stream end");
   }

virtual std::string Botan::Decompression_Algorithm::name ( ) const

pure virtualinherited

Returns

name of the decompression algorithm

Implemented in Botan::Gzip_Decompression, Botan::Deflate_Decompression, Botan::LZMA_Decompression, Botan::Bzip2_Decompression, and Botan::Zlib_Decompression.

Referenced by finish().

void Botan::Stream_Decompression::update ( secure_vector< uint8_t > &  buf, size_t  offset  )

finaloverridevirtual

Process some data. Input must be in size update_granularity() uint8_t blocks.

Parameters

buf	in/out parameter which will possibly be resized or swapped
offset	an offset into blocks to begin processing

Implements Botan::Decompression_Algorithm.

Definition at line 175 of file compress_utils.cpp.

   {
   process(buf, offset, m_stream->run_flag());
   }

---

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

• src/lib/compression/compression.h
• src/lib/compression/compress_utils.cpp