Botan 3.0.0-alpha0
Crypto and TLS for C&
Public Member Functions | Static Public Member Functions | List of all members
Botan::Decompression_Algorithm Class Referenceabstract

#include <compression.h>

Inheritance diagram for Botan::Decompression_Algorithm:
Botan::Stream_Decompression Botan::Bzip2_Decompression Botan::Deflate_Decompression Botan::Gzip_Decompression Botan::LZMA_Decompression Botan::Zlib_Decompression

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_Algorithmcreate (const std::string &algo_spec)
 
static std::unique_ptr< Decompression_Algorithmcreate_or_throw (const std::string &algo_spec)
 

Detailed Description

Definition at line 81 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 ( const std::string &  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.

68 {
69#if defined(BOTAN_HAS_ZLIB)
70 if(name == "Zlib" || name == "zlib")
71 return std::make_unique<Zlib_Decompression>();
72 if(name == "Gzip" || name == "gzip" || name == "gz")
73 return std::make_unique<Gzip_Decompression>();
74 if(name == "Deflate" || name == "deflate")
75 return std::make_unique<Deflate_Decompression>();
76#endif
77
78#if defined(BOTAN_HAS_BZIP2)
79 if(name == "bzip2" || name == "bz2" || name == "Bzip2")
80 return std::make_unique<Bzip2_Decompression>();
81#endif
82
83#if defined(BOTAN_HAS_LZMA)
84 if(name == "lzma" || name == "xz" || name == "LZMA")
85 return std::make_unique<LZMA_Decompression>();
86#endif
87
89 return nullptr;
90 }
#define BOTAN_UNUSED(...)
Definition: assert.h:141
virtual std::string name() const =0

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 ( const std::string &  algo_spec)
static

Create an instance based on a name

Parameters
algo_specalgorithm name Throws Lookup_Error if not found.

Definition at line 94 of file compression.cpp.

95 {
96 if(auto decompressor = Decompression_Algorithm::create(algo))
97 {
98 return decompressor;
99 }
100 throw Lookup_Error("Decompression", algo, "");
101 }
static std::unique_ptr< Decompression_Algorithm > create(const std::string &algo_spec)
Definition: compression.cpp:67

References create().

◆ finish()

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

Finish decompressing

Parameters
final_blockin/out parameter
offsetan offset into final_block to begin processing

Implemented in Botan::Stream_Decompression.

◆ name()

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

◆ start()

virtual void Botan::Decompression_Algorithm::start ( )
pure virtual

Begin decompressing. Decompression does not support levels, as compression does.

◆ update()

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

Process some data.

Parameters
bufin/out parameter which will possibly be resized or swapped
offsetan offset into blocks to begin processing

Implemented in Botan::Stream_Decompression.


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