Botan::System_Error Class Reference

#include <exceptn.h>

Inheritance diagram for Botan::System_Error:

Public Member Functions
int	error_code () const noexcept override
ErrorType	error_type () const noexcept override
	System_Error (std::string_view msg)
	System_Error (std::string_view msg, int err_code)
const char *	what () const noexcept override

Detailed Description

System_Error

This exception is thrown in the event of an error related to interacting with the operating system.

This exception type also (optionally) captures an integer error code eg POSIX errno or Windows GetLastError.

Definition at line 435 of file exceptn.h.

Constructor & Destructor Documentation

System_Error() [1/2]

Botan::System_Error::System_Error ( std::string_view msg )

inlineexplicit

Create a System_Error exception

Parameters

msg	a description of the problem

Definition at line 441 of file exceptn.h.

: Exception(msg), m_error_code(0) {}

References Botan::Exception::Exception().

System_Error() [2/2]

Botan::System_Error::System_Error	(	std::string_view	msg,
		int	err_code )

Create a System_Error exception

Parameters

msg	a description of the problem
err_code	the operating system error code

Definition at line 137 of file exceptn.cpp.

                                                           :
      Exception(fmt("{} error code {}", msg, err_code)), m_error_code(err_code) {}

References Botan::Exception::Exception(), and Botan::fmt().

Member Function Documentation

error_code()

int Botan::System_Error::error_code ( ) const

inlineoverridevirtualnoexcept

Return the operating system error code associated with this exception

Returns

the operating system error code captured at construction

Reimplemented from Botan::Exception.

Definition at line 460 of file exceptn.h.

{ return m_error_code; }

error_type()

ErrorType Botan::System_Error::error_type ( ) const

inlineoverridevirtualnoexcept

Return the error type of this exception

Returns

the error type of this exception

Reimplemented from Botan::Exception.

Definition at line 454 of file exceptn.h.

{ return ErrorType::SystemError; }

References Botan::SystemError.

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

{ return m_msg.c_str(); }

Referenced by Botan::TLS::Certificate_12::Certificate_12(), Botan::TLS::Certificate_13::Certificate_Entry::Certificate_Entry(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::CommonCrypto_Error::CommonCrypto_Error(), Botan::CommonCrypto_Error::CommonCrypto_Error(), Botan::ASN1_Time::decode_from(), Exception(), Botan_FFI::FFI_Error::FFI_Error(), Botan_FFI::ffi_guard_thunk(), Botan::PKCS11::PKCS11_Error::PKCS11_Error(), Botan::SQL_Database::SQL_DB_Error::SQL_DB_Error(), Botan::SQL_Database::SQL_DB_Error::SQL_DB_Error(), Botan::TLS::Callbacks::tls_ephemeral_key_agreement(), Botan::TLS::Callbacks::tls_kem_decapsulate(), Botan::TLS::Callbacks::tls_kem_encapsulate(), and Botan::X509_Certificate::to_string().

---

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

• src/lib/utils/exceptn.h
• src/lib/utils/exceptn.cpp