Botan 3.3.0
Crypto and TLS for C&
Public Member Functions | List of all members
Botan_FFI::FFI_Error Class Referencefinal

#include <ffi_util.h>

Inheritance diagram for Botan_FFI::FFI_Error:
Botan::Exception

Public Member Functions

int error_code () const noexcept override
 
Botan::ErrorType error_type () const noexcept override
 
 FFI_Error (std::string_view what, int err_code)
 
const char * what () const noexcept override
 

Detailed Description

Definition at line 20 of file ffi_util.h.

Constructor & Destructor Documentation

◆ FFI_Error()

Botan_FFI::FFI_Error::FFI_Error ( std::string_view what,
int err_code )
inline

Definition at line 22 of file ffi_util.h.

22: Exception("FFI error", what), m_err_code(err_code) {}
const char * what() const noexcept override
Definition exceptn.h:93
Exception(std::string_view msg)
Definition exceptn.cpp:71

Member Function Documentation

◆ error_code()

int Botan_FFI::FFI_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 24 of file ffi_util.h.

24{ return m_err_code; }

Referenced by Botan_FFI::ffi_guard_thunk().

◆ error_type()

Botan::ErrorType Botan_FFI::FFI_Error::error_type ( ) const
inlineoverridevirtualnoexcept

Return the "type" of error which occurred.

Reimplemented from Botan::Exception.

Definition at line 26 of file ffi_util.h.

References Botan::InvalidArgument.

Referenced by Botan_FFI::ffi_guard_thunk().

◆ 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 file: