Botan::Invalid_Argument Class Reference

#include <exceptn.h>

Inheritance diagram for Botan::Invalid_Argument:

Public Member Functions
virtual int	error_code () const noexcept
ErrorType	error_type () const noexcept override
	Invalid_Argument (std::string_view msg)
	Invalid_Argument (std::string_view msg, const std::exception &e)
	Invalid_Argument (std::string_view msg, std::string_view where)
const char *	what () const noexcept override

Detailed Description

An invalid argument was provided to an API call.

Definition at line 132 of file exceptn.h.

Constructor & Destructor Documentation

Invalid_Argument() [1/3]

Botan::Invalid_Argument::Invalid_Argument ( std::string_view msg )

explicit

Create a Invalid_Argument exception

Parameters

msg	a description of the problem

Definition at line 77 of file exceptn.cpp.

: Exception(msg) {}

References Botan::Exception::Exception().

Referenced by Botan::Invalid_Algorithm_Name::Invalid_Algorithm_Name(), Botan::Invalid_IV_Length::Invalid_IV_Length(), Botan::Invalid_Key_Length::Invalid_Key_Length(), Botan::Pipe::Invalid_Message_Number::Invalid_Message_Number(), and Botan::Unknown_PK_Field_Name::Unknown_PK_Field_Name().

Invalid_Argument() [2/3]

Botan::Invalid_Argument::Invalid_Argument ( std::string_view msg, std::string_view where )

explicit

Create a Invalid_Argument exception

Parameters

msg	a description of the problem
where	the API call which received the invalid argument

Definition at line 79 of file exceptn.cpp.

                                                                           :
      Exception(fmt("{} in {}", msg, where)) {}

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

Invalid_Argument() [3/3]

Botan::Invalid_Argument::Invalid_Argument	(	std::string_view	msg,
		const std::exception &	e )

Create a Invalid_Argument exception

Parameters

msg	a description of the problem
e	the exception which caused this one

Definition at line 82 of file exceptn.cpp.

: Exception(msg, e) {}

References Botan::Exception::Exception().

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::CommonCrypto_Error, Botan::Compression_Error, Botan::PKCS11::PKCS11_ReturnError, Botan::SQL_Database::SQL_DB_Error, Botan::System_Error, Botan::TLS::TLS_Exception, Botan::TPM2::Error, and Botan_FFI::FFI_Error.

Definition at line 108 of file exceptn.h.

{ return 0; }

error_type()

ErrorType Botan::Invalid_Argument::error_type ( ) const

inlineoverridevirtualnoexcept

Return the error type of this exception

Returns

the error type of this exception

Reimplemented from Botan::Exception.

Reimplemented in Botan::Invalid_IV_Length, and Botan::Invalid_Key_Length.

Definition at line 158 of file exceptn.h.

{ return ErrorType::InvalidArgument; }

References Botan::InvalidArgument.

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