Exception Class Reference

#include <peak_afl/peak_afl.hpp>

Inheritance diagram for Exception:

Public Member Functions
PEAK_AFL_NO_DISCARD peak_afl_status	code () const
	Get the return code for the failure.
PEAK_AFL_NO_DISCARD const char *	what () const noexcept override
	Get the string representation for the exception.

Static Public Member Functions
static PEAK_AFL_NO_DISCARD std::string	translateCode (peak_afl_status status)
	Get a string representation for an error code.

Detailed Description

General Error type

Member Function Documentation

code()

PEAK_AFL_NO_DISCARD peak_afl_status code ( ) const

inline

Get the return code for the failure.

Returns

the return code

Since

1.1

translateCode()

static PEAK_AFL_NO_DISCARD std::string translateCode ( peak_afl_status status )

inlinestatic

Get a string representation for an error code.

Parameters

status

the status code of an exception

Returns

the string representation for that code

Since

1.1

what()

PEAK_AFL_NO_DISCARD const char * what ( ) const

inlineoverridenoexcept

Get the string representation for the exception.

Returns

the string explaining the exception

Since

1.1

---

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

• peak_afl/peak_afl.hpp