Botan 3.0.0
Crypto and TLS for C&
Public Member Functions | List of all members
Botan::Compression_Error Class Referencefinal

#include <compression.h>

Inheritance diagram for Botan::Compression_Error:

Public Member Functions

 Compression_Error (const char *func_name, ErrorType type, int rc)
int error_code () const noexcept override
ErrorType error_type () const noexcept override
const char * what () const noexcept override

Detailed Description

An error that occurred during compression (or decompression)

Definition at line 149 of file compression.h.

Constructor & Destructor Documentation

◆ Compression_Error()

Botan::Compression_Error::Compression_Error ( const char *  func_name,
ErrorType  type,
int  rc 
func_namethe name of the compression API that was called (eg "BZ2_bzCompressInit" or "lzma_code")
typewhat library this came from
rcthe error return code from the compression API. The interpretation of this value will depend on the library.

Definition at line 16 of file compress_utils.cpp.

16 :
17 Exception(fmt("Compression API {} failed with return code {}", func_name, rc)),
18 m_type(type),
19 m_rc(rc)
20 {}
Exception(std::string_view msg)
Definition: exceptn.cpp:72
std::string fmt(std::string_view format, const T &... args)
Definition: fmt.h:60

Member Function Documentation

◆ error_code()

int Botan::Compression_Error::error_code ( ) const

Return an error code associated with this exception, or otherwise 0.

The domain of this error varies depending on the source, for example on POSIX systems it might be errno, while on a Windows system it might be the result of GetLastError or WSAGetLastError.

Reimplemented from Botan::Exception.

Definition at line 164 of file compression.h.

164{ return m_rc; }

◆ error_type()

ErrorType Botan::Compression_Error::error_type ( ) const

Return the "type" of error which occurred.

Reimplemented from Botan::Exception.

Definition at line 162 of file compression.h.

162{ return m_type; }

◆ what()

const char * Botan::Exception::what ( ) const

Return a descriptive string which is hopefully comprehensible to a developer. It will likely not be useful for an end user.

The string has no particular format, and the content of exception messages may change from release to release. Thus the main use of this function is for logging or debugging.

Definition at line 94 of file exceptn.h.

94{ return m_msg.c_str(); }

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), and Botan_FFI::ffi_guard_thunk().

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