Botan::Decoding_Error Class Reference

#include <exceptn.h>

Inheritance diagram for Botan::Decoding_Error:

Public Member Functions
	Decoding_Error (std::string_view category, std::string_view err)
	Decoding_Error (std::string_view msg, const std::exception &e)
	Decoding_Error (std::string_view name)
virtual int	error_code () const noexcept
ErrorType	error_type () const noexcept override
const char *	what () const noexcept override

Detailed Description

A decoding error occurred.

Definition at line 245 of file exceptn.h.

Constructor & Destructor Documentation

Decoding_Error() [1/3]

Botan::Decoding_Error::Decoding_Error ( std::string_view name )

explicit

Create a Decoding_Error exception

Parameters

name	a description of the decoding which failed

Definition at line 125 of file exceptn.cpp.

: Exception(name) {}

References Botan::Exception::Exception().

Referenced by Botan::BER_Decoding_Error::BER_Decoding_Error(), Botan::PKCS8_Exception::PKCS8_Exception(), and Botan::Roughtime::Roughtime_Error::Roughtime_Error().

Decoding_Error() [2/3]

Botan::Decoding_Error::Decoding_Error	(	std::string_view	category,
		std::string_view	err )

Create a Decoding_Error exception

Parameters

category	the kind of object being decoded
err	a description of the problem

Definition at line 127 of file exceptn.cpp.

                                                                          :
      Exception(fmt("{}: {}", category, err)) {}

References Botan::Exception::Exception(), and Botan::fmt().

Decoding_Error() [3/3]

Botan::Decoding_Error::Decoding_Error	(	std::string_view	msg,
		const std::exception &	e )

Create a Decoding_Error exception

Parameters

msg	a description of the problem
e	the exception which caused this one

Definition at line 130 of file exceptn.cpp.

: Exception(msg, e) {}

References Botan::Exception::Exception().

Member Function Documentation

error_code()

virtual int Botan::Exception::error_code ( ) const

inlinevirtualnoexceptinherited

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 in Botan::CommonCrypto_Error, Botan::Compression_Error, Botan::PKCS11::PKCS11_ReturnError, Botan::SQL_Database::SQL_DB_Error, Botan::System_Error, Botan::TLS::TLS_Exception, Botan::TPM2::Error, and Botan_FFI::FFI_Error.

Definition at line 108 of file exceptn.h.

{ return 0; }

error_type()

ErrorType Botan::Decoding_Error::error_type ( ) const

inlineoverridevirtualnoexcept

Return the error type of this exception

Returns

the error type of this exception

Reimplemented from Botan::Exception.

Reimplemented in Botan::Roughtime::Roughtime_Error.

Definition at line 271 of file exceptn.h.

{ return ErrorType::DecodingFailure; }

References Botan::DecodingFailure.

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

{ return m_msg.c_str(); }

Referenced by Botan::TLS::Certificate_12::Certificate_12(), Botan::TLS::Certificate_13::Certificate_Entry::Certificate_Entry(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::CommonCrypto_Error::CommonCrypto_Error(), Botan::CommonCrypto_Error::CommonCrypto_Error(), Botan::ASN1_Time::decode_from(), Exception(), Botan_FFI::FFI_Error::FFI_Error(), Botan_FFI::ffi_guard_thunk(), Botan::PKCS11::PKCS11_Error::PKCS11_Error(), Botan::SQL_Database::SQL_DB_Error::SQL_DB_Error(), Botan::SQL_Database::SQL_DB_Error::SQL_DB_Error(), Botan::TLS::Callbacks::tls_ephemeral_key_agreement(), Botan::TLS::Callbacks::tls_kem_decapsulate(), Botan::TLS::Callbacks::tls_kem_encapsulate(), and Botan::X509_Certificate::to_string().

---

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

• src/lib/utils/exceptn.h
• src/lib/utils/exceptn.cpp