Botan::Decoding_Error Class Reference

#include <exceptn.h>

Inheritance diagram for Botan::Decoding_Error:

Public Member Functions
	Decoding_Error (const std::string &name)
	Decoding_Error (const std::string &name, const char *exception_message)
	Decoding_Error (const std::string &msg, const std::exception &e)
virtual int	error_code () const noexcept
ErrorType	error_type () const noexcept override
const char *	what () const noexcept override

Detailed Description

A decoding error occurred.

This exception derives from Invalid_Argument for historical reasons, and it does not make any real sense for it to do so. In a future major release this exception type will derive directly from Exception instead.

Definition at line 180 of file exceptn.h.

Constructor & Destructor Documentation

Decoding_Error() [1/3]

Botan::Decoding_Error::Decoding_Error ( const std::string &  name )

explicit

Definition at line 85 of file exceptn.cpp.

                                                    :
   Invalid_Argument(name)
   {}

Decoding_Error() [2/3]

Botan::Decoding_Error::Decoding_Error	(	const std::string &	name,
		const char *	exception_message
	)

Definition at line 93 of file exceptn.cpp.

                                                                                   :
   Invalid_Argument(name + " failed with exception " + exception_message) {}

Decoding_Error() [3/3]

Botan::Decoding_Error::Decoding_Error	(	const std::string &	msg,
		const std::exception &	e
	)

Definition at line 89 of file exceptn.cpp.

                                                                          :
   Invalid_Argument(msg, e)
   {}

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. For error_type() is OpenSSLError, it will (if nonzero) be an OpenSSL error code from ERR_get_error.

Reimplemented in Botan::System_Error, Botan::Compression_Error, Botan::OpenSSL_Error, Botan::CommonCrypto_Error, Botan::TLS::TLS_Exception, and Botan_FFI::FFI_Error.

Definition at line 103 of file exceptn.h.

{ return 0; }

error_type()

ErrorType Botan::Decoding_Error::error_type ( ) const

inlineoverridevirtualnoexcept

Return the "type" of error which occurred.

Reimplemented from Botan::Invalid_Argument.

Definition at line 189 of file exceptn.h.

References Botan::DecodingFailure.

{ return ErrorType::DecodingFailure; }

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

Referenced by Botan::RSA_PrivateKey::create_decryption_op(), Botan::RSA_PublicKey::create_encryption_op(), and Botan_FFI::ffi_guard_thunk().

{ return m_msg.c_str(); }

---

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

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