std::expected<T,E>::error

From cppreference.com
< cpp‎ | utility‎ | expected
 
 
Utilities library
General utilities
Date and time
Function objects
Formatting library (C++20)
(C++11)
Relational operators (deprecated in C++20)
Integer comparison functions
(C++20)(C++20)(C++20)   
(C++20)
Swap and type operations
(C++14)
(C++11)
(C++11)
(C++11)
(C++17)
Common vocabulary types
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)
(C++23)
Elementary string conversions
(C++17)
(C++17)
 
std::expected
Member functions
Observers
expected::error
(C++23)
Monadic operations
Modifiers
Non-member functions
(C++23)
(C++23)
Helper classes
(C++23)
(C++23)(C++23)
 
constexpr const E& error() const& noexcept;
(1) (since C++23)
constexpr E& error() & noexcept;
(2) (since C++23)
constexpr const E&& error() const&& noexcept;
(3) (since C++23)
constexpr E&& error() && noexcept;
(4) (since C++23)

Accesses the unexpected value contained in *this.

The behavior is undefined if this->has_value() is true.

Parameters

(none)

Return value

Reference to the unexpected value contained in *this.

Example

See also

accesses the expected value
(public member function)
(C++23)
returns the expected value
(public member function)
checks whether the object contains an expected value
(public member function)