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

#include <commoncrypto.h>

Inheritance diagram for Botan::CommonCrypto_Error:
Botan::Exception

Public Member Functions

 CommonCrypto_Error (const std::string &what)
 
 CommonCrypto_Error (const std::string &what, int32_t status)
 
int error_code () const noexcept override
 
ErrorType error_type () const noexcept override
 
const char * what () const noexcept override
 

Detailed Description

Definition at line 25 of file commoncrypto.h.

Constructor & Destructor Documentation

◆ CommonCrypto_Error() [1/2]

Botan::CommonCrypto_Error::CommonCrypto_Error ( const std::string &  what)
inline

Definition at line 28 of file commoncrypto.h.

Referenced by Botan::commoncrypto_opts_from_algo().

28  :
29  Exception(what + " failed."),
30  m_rc(0) {}
Exception(const std::string &msg)
Definition: exceptn.cpp:11
const char * what() const noexcept override
Definition: exceptn.h:89

◆ CommonCrypto_Error() [2/2]

Botan::CommonCrypto_Error::CommonCrypto_Error ( const std::string &  what,
int32_t  status 
)
inline

Definition at line 32 of file commoncrypto.h.

32  :
33  Exception(what + std::string(" failed. Status: ") + ccryptorstatus_to_string(status)),
34  m_rc(status) {}
Exception(const std::string &msg)
Definition: exceptn.cpp:11
const char * what() const noexcept override
Definition: exceptn.h:89

Member Function Documentation

◆ error_code()

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

Reimplemented from Botan::Exception.

Definition at line 38 of file commoncrypto.h.

References Botan::make_commoncrypto_block_cipher(), Botan::make_commoncrypto_cipher_mode(), Botan::make_commoncrypto_hash(), and name.

38 { return m_rc; }

◆ error_type()

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

Return the "type" of error which occurred.

Reimplemented from Botan::Exception.

Definition at line 36 of file commoncrypto.h.

References Botan::CommonCryptoError.

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

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

89 { return m_msg.c_str(); }

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