Botan::Invalid_Key_Length Class Reference

#include <exceptn.h>

Inheritance diagram for Botan::Invalid_Key_Length:

Public Member Functions
virtual int	error_code () const noexcept
ErrorType	error_type () const noexcept override
	Invalid_Key_Length (std::string_view name, size_t length)
const char *	what () const noexcept override

Detailed Description

An invalid key length was used

Definition at line 156 of file exceptn.h.

Constructor & Destructor Documentation

Invalid_Key_Length()

Botan::Invalid_Key_Length::Invalid_Key_Length	(	std::string_view	name,
		size_t	length
	)

Definition at line 123 of file exceptn.cpp.

                                                                         :
   Invalid_Argument(fmt("{} cannot accept a key of length {}", name, length))
   {}

Member Function Documentation

error_code()

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

inlinevirtualnoexceptinherited

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.

{ return 0; }

error_type()

ErrorType Botan::Invalid_Key_Length::error_type ( ) const

inlineoverridevirtualnoexcept

Return the "type" of error which occurred.

Reimplemented from Botan::Invalid_Argument.

Definition at line 160 of file exceptn.h.

{ return ErrorType::InvalidKeyLength; }

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::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/utils/exceptn.h
• src/lib/utils/exceptn.cpp