`nothrow_op` Struct

Operator struct to check if an expression does not throw any exception. More...

Declaration

struct micro_os_plus::micro_test_plus::detail::nothrow_op { ... }

Included Headers

#include "micro-os-plus/micro-test-plus.h"

Base struct

struct	callable_op
	Common base struct for callable-wrapping operators. More...

Public Member Typedefs Index

using	op_type = op
	Marker identifying the framework expression types. More...

Public Constructors Index

template <class Callable_T>
nothrow_op (Callable_T &&func)
	Constructs a nothrow checking operator for the given callable. More...

Public Operators Index

constexpr	operator bool () const
	Conversion operator to boolean. More...

Public Member Functions Index

throw_outcome	outcome (void) const noexcept
	Retrieves what the invocation threw. More...

const std::string &	what (void) const noexcept
	Retrieves the what() of the std::exception thrown. More...

Private Member Attributes Index

throw_outcome	outcome_ { throw_outcome::none }
	Stores what the invocation threw, when the check failed. More...

const bool	value_ {}
	Stores the result of the callable invocation. More...

std::string	what_ {}
	Stores the what() of the std::exception thrown, when the check failed. More...

Description

Operator struct to check if an expression does not throw any exception.

This struct checks whether invoking the given callable completes without throwing an exception. The check is performed at construction time, with the result cached for reporting and composition. Use this when a test must verify that an operation does not throw.

The callable is a parameter of the constructor only, so all the checks share one struct, and one formatter overload.

Definition at line 1562 of file detail.h.

Public Member Typedefs

op_type

using micro_os_plus::micro_test_plus::detail::op::op_type = op

Marker identifying the framework expression types.

Detected by the extension::is_op concept, and inherited by all types derived from op.

Definition at line 128 of file extension.h.

128 using op_type = op;

Public Constructors

nothrow_op()

template <class Callable_T>

micro_os_plus::micro_test_plus::detail::nothrow_op::nothrow_op (Callable_T && func)

explicit

Constructs a nothrow checking operator for the given callable.

Template Parameters

Callable_T

The type of the callable object to be invoked; it must be invocable without arguments, as an lvalue, so a mutable lambda is accepted.

Parameters

func	The callable object to be invoked.

Invokes func inside a try/catch block. If func completes without throwing, the result is true; if any exception is thrown the result is false. The result is passed to the callable_op base class constructor, with what was thrown, if the result is false, to be written in the report: a std::exception, with its what(), or another exception.

The failed_requirement thrown to stop the test case after a failed require() in func is not an exception of func, and is rethrown.

Declaration at line 1575 of file detail.h, definition at line 1273 of file detail-inlines.h.

1273 requires std::invocable<Callable_T&>

1274 nothrow_op::nothrow_op (Callable_T&& func)

1275 : callable_op{ [&func] () -> callable_result

1276 {

1277 try

1278 {

1279 func ();

1280 }

1281 catch (const failed_requirement&)

1282 {

1283 throw;

1284 }

1285 catch (const std::exception& e)

1286 {

1287 return { false, throw_outcome::std_exception,

1288 e.what () != nullptr ? e.what () : "" };

1289 }

1290 catch (...)

1291 {

1292 return { false, throw_outcome::unknown_exception, {} };

1293 }

1294 return { true, throw_outcome::none, {} };

1295 }() }

1296 {

References micro_os_plus::micro_test_plus::detail::callable_op::callable_op, nothrow_op, micro_os_plus::micro_test_plus::detail::none, micro_os_plus::micro_test_plus::detail::std_exception and micro_os_plus::micro_test_plus::detail::unknown_exception.

Referenced by nothrow_op.

Public Operators

operator bool()

micro_os_plus::micro_test_plus::detail::callable_op::operator bool ()

nodiscard constexpr

Conversion operator to boolean.

Parameters: None.

Returns: The result of the callable invocation.

Returns the result computed by the constructor of the derived operator; the callable is not invoked again.

Declaration at line 1420 of file detail.h, definition at line 1137 of file detail-inlines.h.

1137 constexpr callable_op::

1138 operator bool () const

1139 {

1140 return value_;

Reference micro_os_plus::micro_test_plus::detail::callable_op::value_.

Public Member Functions

outcome()

throw_outcome micro_os_plus::micro_test_plus::detail::callable_op::outcome (void)

inline nodiscard noexcept

Retrieves what the invocation threw.

Parameters: None.

Returns: The kind of the exception thrown, throw_outcome::none if the callable completed, or if the expected exception was thrown.

Returns what was recorded when the check failed.

Declaration at line 1432 of file detail.h, definition at line 1147 of file detail-inlines.h.

1147 inline throw_outcome

1148 callable_op::outcome (void) const noexcept

1149 {

1150 return outcome_;

Reference micro_os_plus::micro_test_plus::detail::callable_op::outcome_.

Referenced by micro_os_plus::micro_test_plus::detail::callable_op::callable_op.

what()

const std::string & micro_os_plus::micro_test_plus::detail::callable_op::what (void)

inline nodiscard noexcept

Retrieves the what() of the std::exception thrown.

Parameters: None.

Returns: The text, empty unless the outcome is throw_outcome::std_exception.

Returns the text recorded when a std::exception was thrown.

Declaration at line 1443 of file detail.h, definition at line 1157 of file detail-inlines.h.

1157 inline const std::string&

1158 callable_op::what (void) const noexcept

1159 {

1160 return what_;

Reference micro_os_plus::micro_test_plus::detail::callable_op::what_.

Referenced by micro_os_plus::micro_test_plus::detail::callable_op::callable_op.

Private Member Attributes

outcome_

throw_outcome micro_os_plus::micro_test_plus::detail::callable_op::outcome_ { throw_outcome::none }

Stores what the invocation threw, when the check failed.

Copied from the callable_result by the constructor.

Definition at line 1461 of file detail.h.

1461 throw_outcome outcome_{ throw_outcome::none };

Referenced by micro_os_plus::micro_test_plus::detail::callable_op::callable_op and micro_os_plus::micro_test_plus::detail::callable_op::outcome.

value_

const bool micro_os_plus::micro_test_plus::detail::callable_op::value_ {}

Stores the result of the callable invocation.

Computed once, by the derived operator constructor, which invokes the callable.

Definition at line 1453 of file detail.h.

1453 const bool value_{};

Referenced by micro_os_plus::micro_test_plus::detail::callable_op::callable_op and micro_os_plus::micro_test_plus::detail::callable_op::operator bool.

what_

std::string micro_os_plus::micro_test_plus::detail::callable_op::what_ {}

Stores the what() of the std::exception thrown, when the check failed.

Moved from the callable_result by the constructor; empty in the usual case, so nothing is allocated.

Definition at line 1471 of file detail.h.

1471 std::string what_{};

Referenced by micro_os_plus::micro_test_plus::detail::callable_op::callable_op and micro_os_plus::micro_test_plus::detail::callable_op::what.

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

Generated via doxygen2docusaurus 2.2.8 by Doxygen 1.18.0.

Declaration​

Included Headers​

Base struct​

Public Member Typedefs Index​

Public Constructors Index​

Public Operators Index​

Public Member Functions Index​

Private Member Attributes Index​

Description​

Public Member Typedefs​

op_type​

Public Constructors​

nothrow_op()​

Public Operators​

operator bool()​

Public Member Functions​

outcome()​

what()​

Private Member Attributes​

outcome_​

value_​

what_​