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

#include <exceptn.h>

Inheritance diagram for Botan::Key_Not_Set:
Botan::Invalid_State Botan::Exception

Public Member Functions

virtual int error_code () const noexcept
ErrorType error_type () const noexcept override
 Key_Not_Set (std::string_view algo)
const char * what () const noexcept override

Detailed Description

The key was not set on an object. This occurs with symmetric objects where an operation which requires the key is called prior to set_key being called.

Definition at line 233 of file exceptn.h.

Constructor & Destructor Documentation

◆ Key_Not_Set()

Botan::Key_Not_Set::Key_Not_Set ( std::string_view  algo)

Definition at line 131 of file exceptn.cpp.

131 :
132 Invalid_State(fmt("Key not set in {}", algo))
133 {}
Invalid_State(std::string_view err)
Definition: exceptn.h:215
std::string fmt(std::string_view format, const T &... args)
Definition: fmt.h:60

Member Function Documentation

◆ error_code()

virtual int Botan::Exception::error_code ( ) const

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

108{ return 0; }

◆ error_type()

ErrorType Botan::Key_Not_Set::error_type ( ) const

Return the "type" of error which occurred.

Reimplemented from Botan::Invalid_State.

Definition at line 238 of file exceptn.h.

◆ what()

const char * Botan::Exception::what ( ) const

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.

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