Botan  2.9.0
Crypto and TLS for C++11
Public Member Functions | List of all members
Botan::Encoding_Error Class Referencefinal

#include <exceptn.h>

Inheritance diagram for Botan::Encoding_Error:
Botan::Invalid_Argument Botan::Exception

Public Member Functions

 Encoding_Error (const std::string &name)
 
virtual int error_code () const noexcept
 
ErrorType error_type () const noexcept override
 
const char * what () const noexcept override
 

Detailed Description

Encoding_Error Exception

This exception derives from Invalid_Argument for historical reasons, and it does not make any real sense for it to do so. In a future major release this exception type will derive directly from Exception instead.

Definition at line 165 of file exceptn.h.

Constructor & Destructor Documentation

◆ Encoding_Error()

Botan::Encoding_Error::Encoding_Error ( const std::string &  name)
explicit

Definition at line 81 of file exceptn.cpp.

81  :
82  Invalid_Argument("Encoding error: " + name)
83  {}
Invalid_Argument(const std::string &msg)
Definition: exceptn.cpp:22
std::string name

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. For error_type() is OpenSSLError, it will (if nonzero) be an OpenSSL error code from ERR_get_error.

Reimplemented in Botan::System_Error, Botan::Compression_Error, Botan::OpenSSL_Error, Botan::CommonCrypto_Error, Botan::TLS::TLS_Exception, and Botan_FFI::FFI_Error.

Definition at line 103 of file exceptn.h.

103 { return 0; }

◆ error_type()

ErrorType Botan::Encoding_Error::error_type ( ) const
inlineoverridevirtualnoexcept

Return the "type" of error which occurred.

Reimplemented from Botan::Invalid_Argument.

Definition at line 170 of file exceptn.h.

References Botan::EncodingFailure.

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

Referenced by Botan::RSA_PrivateKey::create_decryption_op(), Botan::RSA_PublicKey::create_encryption_op(), and Botan_FFI::ffi_guard_thunk().

87 { return m_msg.c_str(); }

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