57 KiB
[expected.expected]
22 General utilities library [utilities]
22.8 Expected objects [expected]
22.8.6 Class template expected [expected.expected]
22.8.6.1 General [expected.object.general]
namespace std {template<class T, class E>class expected {public:using value_type = T; using error_type = E; using unexpected_type = unexpected; templateusing rebind = expected<U, error_type>; // [expected.object.cons], constructorsconstexpr expected(); constexpr expected(const expected&); constexpr expected(expected&&) noexcept(see below); template<class U, class G>constexpr explicit(see below) expected(const expected<U, G>&); template<class U, class G>constexpr explicit(see below) expected(expected<U, G>&&); template<class U = remove_cv_t>constexpr explicit(see below) expected(U&& v); templateconstexpr explicit(see below) expected(const unexpected&); templateconstexpr explicit(see below) expected(unexpected&&); template<class... Args>constexpr explicit expected(in_place_t, Args&&...); template<class U, class... Args>constexpr explicit expected(in_place_t, initializer_list, Args&&...); template<class... Args>constexpr explicit expected(unexpect_t, Args&&...); template<class U, class... Args>constexpr explicit expected(unexpect_t, initializer_list, Args&&...); // [expected.object.dtor], destructorconstexpr ~expected(); // [expected.object.assign], assignmentconstexpr expected& operator=(const expected&); constexpr expected& operator=(expected&&) noexcept(see below); template<class U = remove_cv_t> constexpr expected& operator=(U&&); templateconstexpr expected& operator=(const unexpected&); templateconstexpr expected& operator=(unexpected&&); template<class... Args>constexpr T& emplace(Args&&...) noexcept; template<class U, class... Args>constexpr T& emplace(initializer_list, Args&&...) noexcept; // [expected.object.swap], swapconstexpr void swap(expected&) noexcept(see below); friend constexpr void swap(expected& x, expected& y) noexcept(noexcept(x.swap(y))); // [expected.object.obs], observersconstexpr const T* operator->() const noexcept; constexpr T* operator->() noexcept; constexpr const T& operator*() const & noexcept; constexpr T& operator*() & noexcept; constexpr const T&& operator*() const && noexcept; constexpr T&& operator*() && noexcept; constexpr explicit operator bool() const noexcept; constexpr bool has_value() const noexcept; constexpr const T& value() const &; // freestanding-deletedconstexpr T& value() &; // freestanding-deletedconstexpr const T&& value() const &&; // freestanding-deletedconstexpr T&& value() &&; // freestanding-deletedconstexpr const E& error() const & noexcept; constexpr E& error() & noexcept; constexpr const E&& error() const && noexcept; constexpr E&& error() && noexcept; template<class U = remove_cv_t> constexpr T value_or(U&&) const &; template<class U = remove_cv_t> constexpr T value_or(U&&) &&; template constexpr E error_or(G&&) const &; template constexpr E error_or(G&&) &&; // [expected.object.monadic], monadic operationstemplate constexpr auto and_then(F&& f) &; template constexpr auto and_then(F&& f) &&; template constexpr auto and_then(F&& f) const &; template constexpr auto and_then(F&& f) const &&; template constexpr auto or_else(F&& f) &; template constexpr auto or_else(F&& f) &&; template constexpr auto or_else(F&& f) const &; template constexpr auto or_else(F&& f) const &&; template constexpr auto transform(F&& f) &; template constexpr auto transform(F&& f) &&; template constexpr auto transform(F&& f) const &; template constexpr auto transform(F&& f) const &&; template constexpr auto transform_error(F&& f) &; template constexpr auto transform_error(F&& f) &&; template constexpr auto transform_error(F&& f) const &; template constexpr auto transform_error(F&& f) const &&; // [expected.object.eq], equality operatorstemplate<class T2, class E2> requires (!is_void_v)friend constexpr bool operator==(const expected& x, const expected<T2, E2>& y); templatefriend constexpr bool operator==(const expected&, const T2&); templatefriend constexpr bool operator==(const expected&, const unexpected&); private:bool has_val; // exposition onlyunion { T val; // exposition only E unex; // exposition only}; };}
Any object of type expected<T, E> either contains a value of type T or a value of type E nested within ([intro.object]) it.
Member has_val indicates whether the expected<T, E> object contains an object of type T.
A type T is a valid value type for expected, if remove_cv_t is void or a complete non-array object type that is not in_place_t,unexpect_t, or a specialization of unexpected.
A program which instantiates class template expected<T, E> with an argument T that is not a valid value type for expected is ill-formed.
A program that instantiates the definition of the template expected<T, E> with a type for the E parameter that is not a valid template argument for unexpected is ill-formed.
When T is not cv void, it shall meet the Cpp17Destructible requirements (Table 35).
E shall meet the Cpp17Destructible requirements.
22.8.6.2 Constructors [expected.object.cons]
The exposition-only variable template converts-from-any-cvref defined in [optional.ctor] is used by some constructors for expected.
constexpr expected();
Constraints: is_default_constructible_v is true.
Effects: Value-initializes val.
Postconditions: has_value() is true.
Throws: Any exception thrown by the initialization of val.
constexpr expected(const expected& rhs);
Effects: If rhs.has_value() is true, direct-non-list-initializes val with *rhs.
Otherwise, direct-non-list-initializes unex with rhs.error().
Postconditions: rhs.has_value() == this->has_value().
Throws: Any exception thrown by the initialization of val or unex.
Remarks: This constructor is defined as deleted unless
is_copy_constructible_v is true and
is_copy_constructible_v is true.
This constructor is trivial if
is_trivially_copy_constructible_v is true and
is_trivially_copy_constructible_v is true.
constexpr expected(expected&& rhs) noexcept(see below);
Constraints:
is_move_constructible_v is true and
is_move_constructible_v is true.
Effects: If rhs.has_value() is true, direct-non-list-initializes val with std::move(*rhs).
Otherwise, direct-non-list-initializes unex with std::move(rhs.error()).
Postconditions: rhs.has_value() is unchanged;rhs.has_value() == this->has_value() is true.
Throws: Any exception thrown by the initialization of val or unex.
Remarks: The exception specification is equivalent tois_nothrow_move_constructible_v && is_nothrow_move_constructible_v.
This constructor is trivial if
is_trivially_move_constructible_v is true and
is_trivially_move_constructible_v is true.
template<class U, class G> constexpr explicit(see below) expected(const expected<U, G>& rhs); template<class U, class G> constexpr explicit(see below) expected(expected<U, G>&& rhs);
Let:
-
UF be const U& for the first overload andU for the second overload.
-
GF be const G& for the first overload andG for the second overload.
Constraints:
is_constructible_v<T, UF> is true; and
is_constructible_v<E, GF> is true; and
if T is not cv bool,converts-from-any-cvref<T, expected<U, G>> is false; and
is_constructible_v<unexpected, expected<U, G>&> is false; and
is_constructible_v<unexpected, expected<U, G>> is false; and
is_constructible_v<unexpected, const expected<U, G>&> is false; and
is_constructible_v<unexpected, const expected<U, G>> is false.
Effects: If rhs.has_value(), direct-non-list-initializes val with std::forward(*rhs).
Otherwise, direct-non-list-initializes unex with std::forward(rhs.error()).
Postconditions: rhs.has_value() is unchanged;rhs.has_value() == this->has_value() is true.
Throws: Any exception thrown by the initialization of val or unex.
Remarks: The expression inside explicit is equivalent to!is_convertible_v<UF, T> || !is_convertible_v<GF, E>.
template<class U = remove_cv_t<T>> constexpr explicit(!is_convertible_v<U, T>) expected(U&& v);
Constraints:
is_same_v<remove_cvref_t, in_place_t> is false; and
is_same_v<remove_cvref_t, expected> is false; and
is_same_v<remove_cvref_t, unexpect_t> is false; and
remove_cvref_t is not a specialization of unexpected; and
is_constructible_v<T, U> is true; and
if T is cv bool,remove_cvref_t is not a specialization of expected.
Effects: Direct-non-list-initializes val with std::forward(v).
Postconditions: has_value() is true.
Throws: Any exception thrown by the initialization of val.
template<class G> constexpr explicit(!is_convertible_v<const G&, E>) expected(const unexpected<G>& e); template<class G> constexpr explicit(!is_convertible_v<G, E>) expected(unexpected<G>&& e);
Let GF be const G& for the first overload andG for the second overload.
Constraints: is_constructible_v<E, GF> is true.
Effects: Direct-non-list-initializes unex with std::forward(e.error()).
Postconditions: has_value() is false.
Throws: Any exception thrown by the initialization of unex.
template<class... Args> constexpr explicit expected(in_place_t, Args&&... args);
Constraints: is_constructible_v<T, Args...> is true.
Effects: Direct-non-list-initializes val with std::forward(args)....
Postconditions: has_value() is true.
Throws: Any exception thrown by the initialization of val.
template<class U, class... Args> constexpr explicit expected(in_place_t, initializer_list<U> il, Args&&... args);
Constraints: is_constructible_v<T, initializer_list&, Args...> is true.
Effects: Direct-non-list-initializes val withil, std::forward(args)....
Postconditions: has_value() is true.
Throws: Any exception thrown by the initialization of val.
template<class... Args> constexpr explicit expected(unexpect_t, Args&&... args);
Constraints: is_constructible_v<E, Args...> is true.
Effects: Direct-non-list-initializes unex withstd::forward(args)....
Postconditions: has_value() is false.
Throws: Any exception thrown by the initialization of unex.
template<class U, class... Args> constexpr explicit expected(unexpect_t, initializer_list<U> il, Args&&... args);
Constraints: is_constructible_v<E, initializer_list&, Args...> is true.
Effects: Direct-non-list-initializes unex withil, std::forward(args)....
Postconditions: has_value() is false.
Throws: Any exception thrown by the initialization of unex.
22.8.6.3 Destructor [expected.object.dtor]
constexpr ~expected();
Effects: If has_value() is true, destroys val, otherwise destroys unex.
Remarks: If is_trivially_destructible_v is true, andis_trivially_destructible_v is true, then this destructor is a trivial destructor.
22.8.6.4 Assignment [expected.object.assign]
This subclause makes use of the following exposition-only function template:template<class T, class U, class... Args>constexpr void reinit-expected(T& newval, U& oldval, Args&&... args) { // exposition onlyif constexpr (is_nothrow_constructible_v<T, Args...>) { destroy_at(addressof(oldval)); construct_at(addressof(newval), std::forward(args)...); } else if constexpr (is_nothrow_move_constructible_v) { T tmp(std::forward(args)...); destroy_at(addressof(oldval)); construct_at(addressof(newval), std::move(tmp)); } else { U tmp(std::move(oldval)); destroy_at(addressof(oldval)); try { construct_at(addressof(newval), std::forward(args)...); } catch (...) { construct_at(addressof(oldval), std::move(tmp)); throw; }}}
constexpr expected& operator=(const expected& rhs);
Effects:
-
If this->has_value() && rhs.has_value() is true, equivalent to val = *rhs.
-
Otherwise, if this->has_value() is true, equivalent to:reinit-expected(unex, val, rhs.error())
-
Otherwise, if rhs.has_value() is true, equivalent to:reinit-expected(val, unex, *rhs)
-
Otherwise, equivalent to unex = rhs.error().
Then, if no exception was thrown, equivalent to: has_val = rhs.has_value(); return *this;
Returns: *this.
Remarks: This operator is defined as deleted unless:
is_copy_assignable_v is true and
is_copy_constructible_v is true and
is_copy_assignable_v is true and
is_copy_constructible_v is true and
is_nothrow_move_constructible_v || is_nothrow_move_constructible_v is true.
constexpr expected& operator=(expected&& rhs) noexcept(see below);
Constraints:
is_move_constructible_v is true and
is_move_assignable_v is true and
is_move_constructible_v is true and
is_move_assignable_v is true and
is_nothrow_move_constructible_v || is_nothrow_move_constructible_v is true.
Effects:
-
If this->has_value() && rhs.has_value() is true, equivalent to val = std::move(*rhs).
-
Otherwise, if this->has_value() is true, equivalent to:reinit-expected(unex, val, std::move(rhs.error()))
-
Otherwise, if rhs.has_value() is true, equivalent to:reinit-expected(val, unex, std::move(*rhs))
-
Otherwise, equivalent to unex = std::move(rhs.error()).
Then, if no exception was thrown, equivalent to: has_val = rhs.has_value(); return *this;
Returns: *this.
Remarks: The exception specification is equivalent to:is_nothrow_move_assignable_v && is_nothrow_move_constructible_v && is_nothrow_move_assignable_v && is_nothrow_move_constructible_v
template<class U = remove_cv_t<T>> constexpr expected& operator=(U&& v);
Constraints:
is_same_v<expected, remove_cvref_t> is false; and
remove_cvref_t is not a specialization of unexpected; and
is_constructible_v<T, U> is true; and
is_assignable_v<T&, U> is true; and
is_nothrow_constructible_v<T, U> || is_nothrow_move_constructible_v ||
is_nothrow_move_constructible_v is true.
Effects:
If has_value() is true, equivalent to: val = std::forward(v);
Otherwise, equivalent to:reinit-expected(val, unex, std::forward(v));has_val = true;
Returns: *this.
template<class G> constexpr expected& operator=(const unexpected<G>& e); template<class G> constexpr expected& operator=(unexpected<G>&& e);
Let GF be const G& for the first overload andG for the second overload.
Constraints:
is_constructible_v<E, GF> is true; and
is_assignable_v<E&, GF> is true; and
is_nothrow_constructible_v<E, GF> || is_nothrow_move_constructible_v ||
is_nothrow_move_constructible_v is true.
Effects:
If has_value() is true, equivalent to:reinit-expected(unex, val, std::forward(e.error()));has_val = false;
Otherwise, equivalent to:unex = std::forward(e.error());
Returns: *this.
template<class... Args> constexpr T& emplace(Args&&... args) noexcept;
Constraints: is_nothrow_constructible_v<T, Args...> is true.
Effects: Equivalent to:if (has_value()) { destroy_at(addressof(val));} else { destroy_at(addressof(unex)); has_val = true;}return *construct_at(addressof(val), std::forward(args)...);
template<class U, class... Args> constexpr T& emplace(initializer_list<U> il, Args&&... args) noexcept;
Constraints: is_nothrow_constructible_v<T, initializer_list&, Args...> is true.
Effects: Equivalent to:if (has_value()) { destroy_at(addressof(val));} else { destroy_at(addressof(unex)); has_val = true;}return *construct_at(addressof(val), il, std::forward(args)...);
22.8.6.5 Swap [expected.object.swap]
constexpr void swap(expected& rhs) noexcept(see below);
Constraints:
is_swappable_v is true and
is_swappable_v is true and
is_move_constructible_v && is_move_constructible_v is true, and
is_nothrow_move_constructible_v || is_nothrow_move_constructible_v is true.
Table 72 — swap(expected&) effects [tab:expected.object.swap]
| ð | this->has_value() | !this->has_value() |
|---|---|---|
| ð rhs.has_value() |
equivalent to: using std::swap; swap(val, rhs.val); | calls rhs.swap(*this) |
| ð !rhs.has_value() |
see below | equivalent to: using std::swap; swap(unex, rhs.unex); |
For the case where rhs.has_value() is false andthis->has_value() is true, equivalent to:if constexpr (is_nothrow_move_constructible_v) { E tmp(std::move(rhs.unex)); destroy_at(addressof(rhs.unex)); try { construct_at(addressof(rhs.val), std::move(val)); destroy_at(addressof(val)); construct_at(addressof(unex), std::move(tmp)); } catch(...) { construct_at(addressof(rhs.unex), std::move(tmp)); throw; }} else { T tmp(std::move(val)); destroy_at(addressof(val)); try { construct_at(addressof(unex), std::move(rhs.unex)); destroy_at(addressof(rhs.unex)); construct_at(addressof(rhs.val), std::move(tmp)); } catch (...) { construct_at(addressof(val), std::move(tmp)); throw; }}has_val = false; rhs.has_val = true;
Throws: Any exception thrown by the expressions in the Effects.
Remarks: The exception specification is equivalent to:is_nothrow_move_constructible_v && is_nothrow_swappable_v && is_nothrow_move_constructible_v && is_nothrow_swappable_v
friend constexpr void swap(expected& x, expected& y) noexcept(noexcept(x.swap(y)));
Effects: Equivalent to x.swap(y).
22.8.6.6 Observers [expected.object.obs]
constexpr const T* operator->() const noexcept; constexpr T* operator->() noexcept;
Hardened preconditions: has_value() is true.
Returns: addressof(val).
constexpr const T& operator*() const & noexcept; constexpr T& operator*() & noexcept;
Hardened preconditions: has_value() is true.
Returns: val.
constexpr T&& operator*() && noexcept; constexpr const T&& operator*() const && noexcept;
Hardened preconditions: has_value() is true.
Returns: std::move(val).
constexpr explicit operator bool() const noexcept; constexpr bool has_value() const noexcept;
Returns: has_val.
constexpr const T& value() const &; constexpr T& value() &;
Mandates: is_copy_constructible_v is true.
Returns: val, if has_value() is true.
Throws: bad_expected_access(as_const(error())) if has_value() is false.
constexpr T&& value() &&; constexpr const T&& value() const &&;
Mandates: is_copy_constructible_v is true andis_constructible_v<E, decltype(std::move(error()))> is true.
Returns: std::move(val), if has_value() is true.
Throws: bad_expected_access(std::move(error())) if has_value() is false.
constexpr const E& error() const & noexcept; constexpr E& error() & noexcept;
Hardened preconditions: has_value() is false.
Returns: unex.
constexpr E&& error() && noexcept; constexpr const E&& error() const && noexcept;
Hardened preconditions: has_value() is false.
Returns: std::move(unex).
template<class U = remove_cv_t<T>> constexpr T value_or(U&& v) const &;
Mandates: is_copy_constructible_v is true andis_convertible_v<U, T> is true.
Returns: has_value() ? **this : static_cast(std::forward(v)).
template<class U = remove_cv_t<T>> constexpr T value_or(U&& v) &&;
Mandates: is_move_constructible_v is true andis_convertible_v<U, T> is true.
Returns: has_value() ? std::move(**this) : static_cast(std::forward(v)).
template<class G = E> constexpr E error_or(G&& e) const &;
Mandates: is_copy_constructible_v is true andis_convertible_v<G, E> is true.
Returns: std::forward(e) if has_value() is true,error() otherwise.
template<class G = E> constexpr E error_or(G&& e) &&;
Mandates: is_move_constructible_v is true andis_convertible_v<G, E> is true.
Returns: std::forward(e) if has_value() is true,std::move(error()) otherwise.
22.8.6.7 Monadic operations [expected.object.monadic]
template<class F> constexpr auto and_then(F&& f) &; template<class F> constexpr auto and_then(F&& f) const &;
Let U be remove_cvref_t<invoke_result_t<F, decltype((val))>>.
Constraints: is_constructible_v<E, decltype(error())> is true.
Mandates: U is a specialization of expected andis_same_v<U::error_type, E> is true.
Effects: Equivalent to:if (has_value())return invoke(std::forward(f), val);elsereturn U(unexpect, error());
template<class F> constexpr auto and_then(F&& f) &&; template<class F> constexpr auto and_then(F&& f) const &&;
Let U beremove_cvref_t<invoke_result_t<F, decltype(std::move(val))>>.
Constraints: is_constructible_v<E, decltype(std::move(error()))> is true.
Mandates: U is a specialization of expected andis_same_v<U::error_type, E> is true.
Effects: Equivalent to:if (has_value())return invoke(std::forward(f), std::move(val));elsereturn U(unexpect, std::move(error()));
template<class F> constexpr auto or_else(F&& f) &; template<class F> constexpr auto or_else(F&& f) const &;
Let G be remove_cvref_t<invoke_result_t<F, decltype(error())>>.
Constraints: is_constructible_v<T, decltype((val))> is true.
Mandates: G is a specialization of expected andis_same_v<G::value_type, T> is true.
Effects: Equivalent to:if (has_value())return G(in_place, val);elsereturn invoke(std::forward(f), error());
template<class F> constexpr auto or_else(F&& f) &&; template<class F> constexpr auto or_else(F&& f) const &&;
Let G beremove_cvref_t<invoke_result_t<F, decltype(std::move(error()))>>.
Constraints: is_constructible_v<T, decltype(std::move(val))> is true.
Mandates: G is a specialization of expected andis_same_v<G::value_type, T> is true.
Effects: Equivalent to:if (has_value())return G(in_place, std::move(val));elsereturn invoke(std::forward(f), std::move(error()));
template<class F> constexpr auto transform(F&& f) &; template<class F> constexpr auto transform(F&& f) const &;
Let U beremove_cv_t<invoke_result_t<F, decltype((val))>>.
Constraints: is_constructible_v<E, decltype(error())> is true.
Mandates: U is a valid value type for expected.
If is_void_v is false, the declarationU u(invoke(std::forward(f), val)); is well-formed.
Effects:
-
If has_value() is false, returnsexpected<U, E>(unexpect, error()).
-
Otherwise, if is_void_v is false, returns anexpected<U, E> object whose has_val member is true and val member is direct-non-list-initialized withinvoke(std::forward(f), val).
-
Otherwise, evaluates invoke(std::forward(f), val) and then returns expected<U, E>().
template<class F> constexpr auto transform(F&& f) &&; template<class F> constexpr auto transform(F&& f) const &&;
Let U beremove_cv_t<invoke_result_t<F, decltype(std::move(val))>>.
Constraints: is_constructible_v<E, decltype(std::move(error()))> is true.
Mandates: U is a valid value type for expected.
If is_void_v isfalse, the declarationU u(invoke(std::forward(f), std::move(val))); is well-formed.
Effects:
-
If has_value() is false, returnsexpected<U, E>(unexpect, std::move(error())).
-
Otherwise, if is_void_v is false, returns anexpected<U, E> object whose has_val member is true and val member is direct-non-list-initialized withinvoke(std::forward(f), std::move(val)).
-
Otherwise, evaluates invoke(std::forward(f), std::move(val)) and then returns expected<U, E>().
template<class F> constexpr auto transform_error(F&& f) &; template<class F> constexpr auto transform_error(F&& f) const &;
Let G be remove_cv_t<invoke_result_t<F, decltype(error())>>.
Constraints: is_constructible_v<T, decltype((val))> is true.
Mandates: G is a valid template argument for unexpected ([expected.un.general]) and the declarationG g(invoke(std::forward(f), error())); is well-formed.
Returns: If has_value() is true,expected<T, G>(in_place, val); otherwise, an expected<T, G> object whose has_val member is false and unex member is direct-non-list-initialized with invoke(std::forward(f), error()).
template<class F> constexpr auto transform_error(F&& f) &&; template<class F> constexpr auto transform_error(F&& f) const &&;
Let G beremove_cv_t<invoke_result_t<F, decltype(std::move(error()))>>.
Constraints: is_constructible_v<T, decltype(std::move(val))> is true.
Mandates: G is a valid template argument for unexpected ([expected.un.general]) and the declarationG g(invoke(std::forward(f), std::move(error()))); is well-formed.
Returns: If has_value() is true,expected<T, G>(in_place, std::move(val)); otherwise, anexpected<T, G> object whose has_val member is false and unex member is direct-non-list-initialized withinvoke(std::forward(f), std::move(error())).
22.8.6.8 Equality operators [expected.object.eq]
template<class T2, class E2> requires (!is_void_v<T2>) friend constexpr bool operator==(const expected& x, const expected<T2, E2>& y);
Constraints: The expressions *x == *y and x.error() == y.error() are well-formed and their results are convertible to bool.
Returns: If x.has_value() does not equal y.has_value(), false; otherwise if x.has_value() is true, *x == *y; otherwise x.error() == y.error().
template<class T2> friend constexpr bool operator==(const expected& x, const T2& v);
Constraints: T2 is not a specialization of expected.
The expression *x == v is well-formed and its result is convertible to bool.
[Note 1:
T need not be Cpp17EqualityComparable.
â end note]
Returns: x.has_value() && static_cast(*x == v).
template<class E2> friend constexpr bool operator==(const expected& x, const unexpected<E2>& e);
Constraints: The expression x.error() == e.error() is well-formed and its result is convertible to bool.
Returns: !x.has_value() && static_cast(x.error() == e.error()).