Botan::CommonCrypto_Error Class Reference

#include <commoncrypto.h>

Inheritance diagram for Botan::CommonCrypto_Error:

Public Member Functions
	CommonCrypto_Error (std::string_view what)
	CommonCrypto_Error (std::string_view 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 26 of file commoncrypto.h.

Constructor & Destructor Documentation

CommonCrypto_Error() [1/2]

Botan::CommonCrypto_Error::CommonCrypto_Error

(

std::string_view

what

)

Definition at line 19 of file commoncrypto_utils.cpp.

: Exception(what), m_rc(0) {}

CommonCrypto_Error() [2/2]

Botan::CommonCrypto_Error::CommonCrypto_Error	(	std::string_view	what,
		int32_t	status )

Definition at line 21 of file commoncrypto_utils.cpp.

                                                                          :
      Exception(fmt("CommonCrypto op {} failed with err {} ({})", what, status, ccryptorstatus_to_string(status))),
      m_rc(status) {}

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.

Reimplemented from Botan::Exception.

Definition at line 34 of file commoncrypto.h.

{ 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 32 of file commoncrypto.h.

{ return ErrorType::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 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/prov/commoncrypto/commoncrypto.h
• src/lib/prov/commoncrypto/commoncrypto_utils.cpp