Botan 3.4.0
Crypto and TLS for C&
Public Member Functions | List of all members
Botan::Decoding_Error Class Reference

#include <exceptn.h>

Inheritance diagram for Botan::Decoding_Error:
Botan::Exception Botan::BER_Decoding_Error Botan::PKCS8_Exception Botan::Roughtime::Roughtime_Error Botan::BER_Bad_Tag

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

Constructor & Destructor Documentation

◆ Decoding_Error() [1/3]

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

Definition at line 125 of file exceptn.cpp.

125: Exception(name) {}
Exception(std::string_view msg)
Definition exceptn.cpp:71
std::string name

◆ Decoding_Error() [2/3]

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

Definition at line 127 of file exceptn.cpp.

127 :
128 Exception(fmt("{}: {}", category, err)) {}
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53

◆ Decoding_Error() [3/3]

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

Definition at line 130 of file exceptn.cpp.

130: Exception(msg, e) {}

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

Definition at line 107 of file exceptn.h.

107{ return 0; }

◆ error_type()

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

Return the "type" of error which occurred.

Reimplemented from Botan::Exception.

Reimplemented in Botan::Roughtime::Roughtime_Error.

Definition at line 199 of file exceptn.h.

◆ 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.

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