Botan::Bzip2_Decompression Class Reference

#include <bzip2.h>

Inheritance diagram for Botan::Bzip2_Decompression:

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

Static Public Member Functions
static std::unique_ptr< Decompression_Algorithm >	create (const std::string &algo_spec)
static std::unique_ptr< Decompression_Algorithm >	create_or_throw (const std::string &algo_spec)

Detailed Description

Bzip2 Deccompression

Definition at line 30 of file bzip2.h.

Member Function Documentation

void Botan::Stream_Decompression::clear ( )

finaloverridevirtualinherited

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 125 of file compress_utils.cpp.

   {
   m_stream.reset();
   }

std::unique_ptr< Decompression_Algorithm > Botan::Decompression_Algorithm::create ( const std::string &  algo_spec )

staticinherited

Create an instance based on a name, or return null if the algo combination cannot be found.

Definition at line 98 of file compression.cpp.

References Botan::make_decompressor().

Referenced by Botan::Decompression_Algorithm::create_or_throw().

   {
   std::unique_ptr<Decompression_Algorithm> decompressor(make_decompressor(algo));
   return decompressor;
   }

std::unique_ptr< Decompression_Algorithm > Botan::Decompression_Algorithm::create_or_throw ( const std::string &  algo_spec )

staticinherited

Create an instance based on a name

Parameters

algo_spec

algorithm name Throws Lookup_Error if not found.

Definition at line 106 of file compression.cpp.

References Botan::Decompression_Algorithm::create().

   {
   if(auto decompressor = Decompression_Algorithm::create(algo))
      {
      return decompressor;
      }
   throw Lookup_Error("Decompression", algo, "");
   }

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

finaloverridevirtualinherited

Finish decompressing

Parameters

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

Implements Botan::Decompression_Algorithm.

Definition at line 187 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 Invalid_State(name() + " finished but not at stream end");
   }

std::string Botan::Bzip2_Decompression::name ( ) const

inlineoverridevirtual

Returns

name of the decompression algorithm

Implements Botan::Decompression_Algorithm.

Definition at line 33 of file bzip2.h.

{ return "Bzip2_Decompression"; }

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

finaloverridevirtualinherited

Process some data.

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 182 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/bzip2/bzip2.h
• src/lib/compression/bzip2/bzip2.cpp