Botan::Decompression_Algorithm Class Reference

#include <compression.h>

Inheritance diagram for Botan::Decompression_Algorithm:

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

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

Detailed Description

Definition at line 93 of file compression.h.

Constructor & Destructor Documentation

~Decompression_Algorithm()

virtual Botan::Decompression_Algorithm::~Decompression_Algorithm ( )

virtualdefault

Member Function Documentation

clear()

virtual void Botan::Decompression_Algorithm::clear ( )

pure virtual

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

Implemented in Botan::Stream_Decompression.

create()

std::unique_ptr< Decompression_Algorithm > Botan::Decompression_Algorithm::create ( std::string_view algo_spec )

static

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

Definition at line 67 of file compression.cpp.

                                                                                          {
#if defined(BOTAN_HAS_ZLIB)
   if(name == "Zlib" || name == "zlib") {
      return std::make_unique<Zlib_Decompression>();
   }
   if(name == "Gzip" || name == "gzip" || name == "gz") {
      return std::make_unique<Gzip_Decompression>();
   }
   if(name == "Deflate" || name == "deflate") {
      return std::make_unique<Deflate_Decompression>();
   }
#endif
 
#if defined(BOTAN_HAS_BZIP2)
   if(name == "bzip2" || name == "bz2" || name == "Bzip2") {
      return std::make_unique<Bzip2_Decompression>();
   }
#endif
 
#if defined(BOTAN_HAS_LZMA)
   if(name == "lzma" || name == "xz" || name == "LZMA") {
      return std::make_unique<LZMA_Decompression>();
   }
#endif
 
   BOTAN_UNUSED(name);
   return nullptr;
}

References BOTAN_UNUSED, and name().

Referenced by create_or_throw(), and Botan::make_decompressor().

create_or_throw()

std::unique_ptr< Decompression_Algorithm > Botan::Decompression_Algorithm::create_or_throw ( std::string_view algo_spec )

static

Create an instance based on a name

Parameters

algo_spec

algorithm name Throws Lookup_Error if not found.

Definition at line 97 of file compression.cpp.

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

References create().

finish()

virtual void Botan::Decompression_Algorithm::finish ( secure_vector< uint8_t > & final_block, size_t offset = 0 )

pure virtual

Finish decompressing

Decompress the material in the in/out parameter buf. The leading offset bytes of buf are ignored and remain untouched; this can be useful for ignoring packet headers.

This function may throw if the data seems to be invalid.

Parameters

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

Implemented in Botan::Stream_Decompression.

name()

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

pure virtual

Returns

name of the decompression algorithm

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

Referenced by create(), and Botan::Stream_Decompression::finish().

start()

virtual void Botan::Decompression_Algorithm::start ( )

pure virtual

Begin decompressing.

This initializes the decompression engine and must be done before calling update() or finish(). No level is provided here; the decompressor can accept input generated by any compression parameters.

Referenced by Botan::Stream_Decompression::finish(), and Botan::Stream_Decompression::update().

update()

virtual void Botan::Decompression_Algorithm::update ( secure_vector< uint8_t > & buf, size_t offset = 0 )

pure virtual

Process some data.

Parameters

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

Implemented in Botan::Stream_Decompression.

---

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

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