#include <tinyformat.h>
#include <stdexcept>
Go to the source code of this file.
|
#define | format_internal_error(msg, file, line, func, report) |
|
#define | CHECK_NONFATAL(condition) inline_check_non_fatal(condition, __FILE__, __LINE__, __func__, #condition) |
| Identity function. More...
|
|
#define | Assert(val) inline_assertion_check<true>(val, __FILE__, __LINE__, __func__, #val) |
| Identity function. More...
|
|
#define | Assume(val) inline_assertion_check<false>(val, __FILE__, __LINE__, __func__, #val) |
| Assume is the identity function. More...
|
|
#define | NONFATAL_UNREACHABLE() |
| NONFATAL_UNREACHABLE() is a macro that is used to mark unreachable code. More...
|
|
|
template<typename T > |
T && | inline_check_non_fatal (T &&val, const char *file, int line, const char *func, const char *assertion) |
| Helper for CHECK_NONFATAL() More...
|
|
void | assertion_fail (const char *file, int line, const char *func, const char *assertion) |
| Helper for Assert() More...
|
|
template<bool IS_ASSERT, typename T > |
T && | inline_assertion_check (T &&val, [[maybe_unused]] const char *file, [[maybe_unused]] int line, [[maybe_unused]] const char *func, [[maybe_unused]] const char *assertion) |
| Helper for Assert()/Assume() More...
|
|
◆ Assert
Identity function.
Abort if the value compares equal to zero
Definition at line 74 of file check.h.
◆ Assume
Assume is the identity function.
- Should be used to run non-fatal checks. In debug builds it behaves like Assert()/assert() to notify developers and testers about non-fatal errors. In production it doesn't warn or log anything.
- For fatal errors, use Assert().
- For non-fatal errors in interactive sessions (e.g. RPC or command line interfaces), CHECK_NONFATAL() might be more appropriate.
Definition at line 86 of file check.h.
◆ CHECK_NONFATAL
#define CHECK_NONFATAL |
( |
|
condition | ) |
inline_check_non_fatal(condition, __FILE__, __LINE__, __func__, #condition) |
Identity function.
Throw a NonFatalCheckError when the condition evaluates to false
This should only be used
- where the condition is assumed to be true, not for error handling or validating user input
- where a failure to fulfill the condition is recoverable and does not abort the program
For example in RPC code, where it is undesirable to crash the whole program, this can be generally used to replace asserts or recoverable logic errors. A NonFatalCheckError in RPC code is caught and passed as a string to the RPC caller, which can then report the issue to the developers.
Definition at line 47 of file check.h.
◆ format_internal_error
#define format_internal_error |
( |
|
msg, |
|
|
|
file, |
|
|
|
line, |
|
|
|
func, |
|
|
|
report |
|
) |
| |
Value: strprintf(
"Internal bug detected: \"%s\"\n%s:%d (%s)\nPlease report this issue here: %s\n", \
msg, file, line, func, report)
Definition at line 21 of file check.h.
◆ NONFATAL_UNREACHABLE
#define NONFATAL_UNREACHABLE |
( |
| ) |
|
◆ assertion_fail()
void assertion_fail |
( |
const char * |
file, |
|
|
int |
line, |
|
|
const char * |
func, |
|
|
const char * |
assertion |
|
) |
| |
◆ inline_assertion_check()
template<bool IS_ASSERT, typename T >
T&& inline_assertion_check |
( |
T && |
val, |
|
|
[[maybe_unused] ] const char * |
file, |
|
|
[[maybe_unused] ] int |
line, |
|
|
[[maybe_unused] ] const char * |
func, |
|
|
[[maybe_unused] ] const char * |
assertion |
|
) |
| |
◆ inline_check_non_fatal()
template<typename T >
T&& inline_check_non_fatal |
( |
T && |
val, |
|
|
const char * |
file, |
|
|
int |
line, |
|
|
const char * |
func, |
|
|
const char * |
assertion |
|
) |
| |