Skip to main content

callable_op Struct

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

Declaration​

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

Included Headers​

Base struct​

structop

Empty base struct for the framework expression types. More...

Derived Structs​

structthrows_op<void>

Operator struct to check if an expression throws any exception. More...

structnothrow_op

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

structthrows_op<Exception_T>

Operator struct template to check if an expression throws a specific exception. More...

structthrows_op<void>

Operator struct to check if an expression throws any exception. More...

Public Member Typedefs Index​

usingop_type = op

Marker identifying the framework expression types. More...

Public Constructors Index​

callable_op (callable_result &&result)

Constructs a callable operator with the pre-computed result. More...

Public Operators Index​

constexproperator bool () const

Conversion operator to boolean. More...

Public Member Functions Index​

throw_outcomeoutcome (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_outcomeoutcome_ { throw_outcome::none }

Stores what the invocation threw, when the check failed. More...

const boolvalue_ {}

Stores the result of the callable invocation. More...

std::stringwhat_ {}

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

Description​

Common base struct for callable-wrapping operators.

The base of the exception-checking operators, throws_op and nothrow_op, which invoke the callable in their constructors. It stores the pre-computed boolean result, and, when the check failed, what was thrown, so that the report can state why (see expression_formatter::append_throw_reason()).

Definition at line 1402 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​

callable_op()​

micro_os_plus::micro_test_plus::detail::callable_op::callable_op (callable_result && result)
inline explicit

Constructs a callable operator with the pre-computed result.

Parameters
result

The result of the invocation, with what was thrown.

Stores the pre-computed boolean result, and, when the check failed, what the invocation threw and the what() of the exception.

Declaration at line 1410 of file detail.h, definition at line 1125 of file detail-inlines.h.

1127 : value_{ result.value }, outcome_{ result.outcome },
1128 what_{ std::move (result.what) }
1129 {

References outcome, outcome_, value_, what and what_.

Referenced by micro_os_plus::micro_test_plus::detail::nothrow_op::nothrow_op, micro_os_plus::micro_test_plus::detail::throws_op< Exception_T >::throws_op and micro_os_plus::micro_test_plus::detail::throws_op< void >::throws_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 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.

1148 callable_op::outcome (void) const noexcept
1149 {
1150 return outcome_;

Reference outcome_.

Referenced by 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 what_.

Referenced by 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.

Referenced by callable_op and 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 callable_op and 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 callable_op and what.


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


Generated via doxygen2docusaurus 2.2.8 by Doxygen 1.18.0.