Botan::Compression_Error Class Reference

#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 143 of file compression.h.

Constructor & Destructor Documentation

Compression_Error()

Botan::Compression_Error::Compression_Error	(	const char *	func_name,
		ErrorType	type,
		int	rc )

Parameters

func_name	the name of the compression API that was called (eg "BZ2_bzCompressInit" or "lzma_code")
type	what library this came from
rc	the error return code from the compression API. The interpretation of this value will depend on the library.

Definition at line 18 of file compress_utils.cpp.

                                                                                  :
      Exception(fmt("Compression API {} failed with return code {}", func_name, rc)), m_type(type), m_rc(rc) {}

Member Function Documentation

error_code()

int Botan::Compression_Error::error_code ( ) const

inlineoverridevirtualnoexcept

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 156 of file compression.h.

{ return m_rc; }

error_type()

ErrorType Botan::Compression_Error::error_type ( ) const

inlineoverridevirtualnoexcept

Return the "type" of error which occurred.

Reimplemented from Botan::Exception.

Definition at line 154 of file compression.h.

{ return m_type; }

what()

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

inlineoverridenoexceptinherited

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 93 of file exceptn.h.

{ 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:

• src/lib/compression/compression.h
• src/lib/compression/compress_utils.cpp