Botan  1.11.15
Public Types | Public Member Functions
Botan::Compressor_Transform Class Reference

#include <compression.h>

Inheritance diagram for Botan::Compressor_Transform:
Botan::Transform Botan::Stream_Compression Botan::Stream_Decompression Botan::Bzip2_Compression Botan::Deflate_Compression Botan::Gzip_Compression Botan::Gzip_Decompression Botan::LZMA_Compression Botan::Zlib_Compression Botan::Bzip2_Decompression Botan::Deflate_Decompression Botan::LZMA_Decompression Botan::Zlib_Decompression

List of all members.

Public Types

typedef SCAN_Name Spec

Public Member Functions

virtual void clear ()=0
size_t default_nonce_length () const override
virtual void finish (secure_vector< byte > &final_block, size_t offset=0)=0
virtual void flush (secure_vector< byte > &buf, size_t offset=0)
size_t minimum_final_size () const override
virtual std::string name () const =0
size_t output_length (size_t) const override
virtual std::string provider () const
template<typename Alloc >
secure_vector< bytestart (const std::vector< byte, Alloc > &nonce)
secure_vector< bytestart (const byte nonce[], size_t nonce_len)
secure_vector< bytestart ()
virtual secure_vector< bytestart_raw (const byte nonce[], size_t nonce_len)=0
template<typename Alloc >
secure_vector< bytestart_vec (const std::vector< byte, Alloc > &nonce)
virtual void update (secure_vector< byte > &blocks, size_t offset=0)=0
size_t update_granularity () const override
bool valid_nonce_length (size_t nonce_len) const override

Detailed Description

Definition at line 15 of file compression.h.


Member Typedef Documentation

typedef SCAN_Name Botan::Transform::Spec [inherited]

Definition at line 27 of file transform.h.


Member Function Documentation

virtual void Botan::Transform::clear ( ) [pure virtual, inherited]
size_t Botan::Compressor_Transform::default_nonce_length ( ) const [inline, override, virtual]

Return the default size for a nonce

Implements Botan::Transform.

Definition at line 22 of file compression.h.

{ return 0; }
virtual void Botan::Transform::finish ( secure_vector< byte > &  final_block,
size_t  offset = 0 
) [pure virtual, inherited]
virtual void Botan::Compressor_Transform::flush ( secure_vector< byte > &  buf,
size_t  offset = 0 
) [inline, virtual]

Reimplemented in Botan::Stream_Compression.

Definition at line 27 of file compression.h.

{ update(buf, offset); }
size_t Botan::Compressor_Transform::minimum_final_size ( ) const [inline, override, virtual]
Returns:
required minimium size to finalize() - may be any length larger than this.

Implements Botan::Transform.

Definition at line 20 of file compression.h.

{ return 0; }
virtual std::string Botan::Transform::name ( ) const [pure virtual, inherited]
size_t Botan::Compressor_Transform::output_length ( size_t  input_length) const [inline, override, virtual]

Returns the size of the output if this transform is used to process a message with input_length bytes. Will throw if unable to give a precise answer.

Implements Botan::Transform.

Definition at line 29 of file compression.h.

         {
         throw std::runtime_error(name() + " output length indeterminate");
         }
virtual std::string Botan::Transform::provider ( ) const [inline, virtual, inherited]

Return some short name describing the provider of this tranformation. Useful in cases where multiple implementations are available (eg, different implementations of AES). Default "core" is used for the 'standard' implementation included in the library.

Definition at line 120 of file transform.h.

{ return "core"; }
template<typename Alloc >
secure_vector<byte> Botan::Transform::start ( const std::vector< byte, Alloc > &  nonce) [inline, inherited]

Begin processing a message.

Parameters:
noncethe per message nonce

Definition at line 34 of file transform.h.

Referenced by botan_cipher_start().

         {
         return start(&nonce[0], nonce.size());
         }
secure_vector<byte> Botan::Transform::start ( const byte  nonce[],
size_t  nonce_len 
) [inline, inherited]

Begin processing a message.

Parameters:
noncethe per message nonce
nonce_lenlength of nonce

Definition at line 55 of file transform.h.

         {
         return start_raw(nonce, nonce_len);
         }
secure_vector<byte> Botan::Transform::start ( ) [inline, inherited]

Begin processing a message.

Definition at line 63 of file transform.h.

         {
         return start_raw(nullptr, 0);
         }
virtual secure_vector<byte> Botan::Transform::start_raw ( const byte  nonce[],
size_t  nonce_len 
) [pure virtual, inherited]
template<typename Alloc >
secure_vector<byte> Botan::Transform::start_vec ( const std::vector< byte, Alloc > &  nonce) [inline, inherited]

Begin processing a message.

Parameters:
noncethe per message nonce

Definition at line 45 of file transform.h.

         {
         return start(&nonce[0], nonce.size());
         }
virtual void Botan::Transform::update ( secure_vector< byte > &  blocks,
size_t  offset = 0 
) [pure virtual, inherited]
size_t Botan::Compressor_Transform::update_granularity ( ) const [inline, override, virtual]
Returns:
size of required blocks to update

Implements Botan::Transform.

Definition at line 18 of file compression.h.

{ return 1; }
bool Botan::Compressor_Transform::valid_nonce_length ( size_t  nonce_len) const [inline, override, virtual]

Return true iff nonce_len is a valid length for the nonce

Implements Botan::Transform.

Definition at line 24 of file compression.h.

         { return nonce_len == 0; }

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