Botan::Stream_Decompression Class Reference

#include <compression.h>

Inheritance diagram for Botan::Stream_Decompression:

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

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

FIXME add doc

Definition at line 220 of file compression.h.

Member Function Documentation

clear()

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

   {
   m_stream.reset();
   }

create()

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

staticinherited

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 Botan::Decompression_Algorithm::name().

Referenced by Botan::Decompression_Algorithm::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 )

staticinherited

Create an instance based on a name

Parameters

algo_spec

algorithm name Throws Lookup_Error if not found.

Definition at line 94 of file compression.cpp.

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

References Botan::Decompression_Algorithm::create().

finish()

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

   {
   if(buf.size() != offset || m_stream.get())
      process(buf, offset, m_stream->finish_flag());
 
   if(m_stream.get())
      throw Invalid_State(fmt("{} finished but not at stream end", name()));
   }

References Botan::fmt(), and Botan::Decompression_Algorithm::name().

name()

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

pure virtualinherited

Returns

name of the decompression algorithm

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

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

update()

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

finaloverridevirtual

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 194 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