failure_type<EC, EP = void> - Boost.Outcome documentation

# `failure_type<EC, EP = void>`

Type sugar for constructing an unsuccessful result or outcome. Generally not constructed directly, but via the free function `failure(T &&, ...)` . Detectable using `is_failure_type<T>` .

This is a regular wrapper type, with defaulted default, copy and move constructor, defaulted assignment, and defaulted destructor.

Member type aliases `error_type` and `exception_type` indicate `EC` and `E`.

There is an explicit initialising constructor taking any types `U` and `V` which will forward construct the contained `error_type` and `exception_type` respectively.

There are two tagged initialising constructors taking `in_place_type_t<error_type>` or `in_place_type_t<exception_type>`, and a `U` which will forward construct the contained `error_type` and `exception_type` respectively.

There are `.error()` and `.exception()` reference observers with the usual constexpr lvalue, const lvalue, rvalue and const rvalue overloads. One can discover which or both of these is valid using the usual `.has_error()` and `.has_exception()` observers.

There are specialisations `failure_type<EC, void>` and `failure_type<void, E>` which store nothing for the voided type and do not provide their observer functions.

Requires: Nothing.

Namespace: `BOOST_OUTCOME_V2_NAMESPACE`

Header: `<boost/outcome/success_failure.hpp>`

Last revised: January 24, 2019 at 01:15:16 UTC