Botan  2.4.0
Crypto and TLS for C++11
Public Member Functions | Static Public Member Functions | List of all members
Botan::Gzip_Decompression Class Referencefinal

#include <zlib.h>

Inheritance diagram for Botan::Gzip_Decompression:
Botan::Stream_Decompression Botan::Decompression_Algorithm

Public Member Functions

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

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

Gzip Decompression

Definition at line 79 of file zlib.h.

Member Function Documentation

◆ clear()

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.

References BOTAN_ASSERT, and Botan::copy_mem().

126  {
127  m_stream.reset();
128  }

◆ create()

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().

99  {
100  std::unique_ptr<Decompression_Algorithm> decompressor(make_decompressor(algo));
101  return decompressor;
102  }
Decompression_Algorithm * make_decompressor(const std::string &name)
Definition: compression.cpp:71

◆ create_or_throw()

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_specalgorithm name Throws Lookup_Error if not found.

Definition at line 106 of file compression.cpp.

References Botan::Decompression_Algorithm::create().

107  {
108  if(auto decompressor = Decompression_Algorithm::create(algo))
109  {
110  return decompressor;
111  }
112  throw Lookup_Error("Decompression", algo, "");
113  }
static std::unique_ptr< Decompression_Algorithm > create(const std::string &algo_spec)
Definition: compression.cpp:98

◆ finish()

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

Finish decompressing

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

Implements Botan::Decompression_Algorithm.

Definition at line 187 of file compress_utils.cpp.

188  {
189  if(buf.size() != offset || m_stream.get())
190  process(buf, offset, m_stream->finish_flag());
191 
192  if(m_stream.get())
193  throw Exception(name() + " finished but not at stream end");
194  }
virtual std::string name() const =0

◆ name()

std::string Botan::Gzip_Decompression::name ( ) const
inlineoverridevirtual
Returns
name of the decompression algorithm

Implements Botan::Decompression_Algorithm.

Definition at line 82 of file zlib.h.

82 { return "Gzip_Decompression"; }

◆ update()

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

Process some data.

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

Implements Botan::Decompression_Algorithm.

Definition at line 182 of file compress_utils.cpp.

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

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