Hyper API for C++ 0.0.20027
Hyper client library for C++ applications
|
Defines an exception object that is thrown on failure by the functions in the Hyper API C++ library. More...
#include <HyperException.hpp>
Public Member Functions | |
HyperException & | operator= (const HyperException &other) noexcept |
Copy assignment operator. | |
HyperException (const HyperException &other) noexcept | |
Copy constructor. | |
HyperException & | operator= (HyperException &&other)=default |
Move assignment operator. | |
HyperException (HyperException &&other)=default | |
Move constructor. | |
const char * | getMainMessage () const noexcept |
Returns the message stored in the exception object, or "" if there is none. | |
const char * | getHint () const noexcept |
Returns the hint message stored in the exception object, or "" if there is none. | |
HYPER_DEPRECATED ("Use getMainMessage() instead. This function will be removed in the future.") const char *getMessage() const noexcept | |
Returns the message stored in the exception object, or "" if there is none. | |
HYPER_DEPRECATED ("Use getHint() instead. This function will be removed in the future.") const char *getHintMessage() const noexcept | |
Returns the hint message stored in the exception object, or "" if there is none. | |
HYPER_DEPRECATED ("Use getCause().has_value() instead. This function will be removed in the future.") bool hasCause() const noexcept | |
Returns whether this error has an underlying cause stored. | |
optional< HyperException > | getCause () const noexcept |
Returns the cause stored in the exception object. | |
ContextId | getContextId () const noexcept |
Returns the context id. | |
std::string | toString () const |
Returns a formatted string containing the message and hint of the error and all causes. | |
const char * | what () const noexcept override |
Returns a null terminated character sequence that may be used to identify the exception. | |
Defines an exception object that is thrown on failure by the functions in the Hyper API C++ library.
Definition at line 41 of file HyperException.hpp.
|
inlinenoexcept |
Returns the context id.
Definition at line 100 of file HyperException.hpp.
|
inlinenoexcept |
Returns the hint message stored in the exception object, or "" if there is none.
Definition at line 60 of file HyperException.hpp.
|
inlinenoexcept |
Returns the message stored in the exception object, or "" if there is none.
Error messages may change between HAPI versions.
Definition at line 55 of file HyperException.hpp.
|
inlinenoexcept |
Returns whether this error has an underlying cause stored.
Definition at line 89 of file HyperException.hpp.
|
inlinenoexcept |
Returns the hint message stored in the exception object, or "" if there is none.
Definition at line 78 of file HyperException.hpp.
|
inlinenoexcept |
Returns the message stored in the exception object, or "" if there is none.
Error messages may change between HAPI versions.
Definition at line 67 of file HyperException.hpp.