utils::expected< S, E > Class Template Reference

#include <userver/utils/expected.hpp>

Detailed Description

template<class S, class E>
class utils::expected< S, E >

For holding a value or an error.

Definition at line 58 of file expected.hpp.

Public Member Functions
	expected (const S &success)
	expected (S &&success)
	expected (const unexpected< E > &error)
	expected (unexpected< E > &&error)
template<class G> requires std::is_convertible_v<G, E>
	expected (const unexpected< G > &error)
template<class G> requires std::is_convertible_v<G, E>
	expected (unexpected< G > &&error)
bool	has_value () const noexcept
	Check whether *this contains an expected value.
	operator bool () const noexcept
	Check whether *this contains an expected value.
S &	value () &USERVER_IMPL_LIFETIME_BOUND
	Return reference to the value or throws bad_expected_access if it's not available.
S &&	value () &&USERVER_IMPL_LIFETIME_BOUND
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const S &	value () const &USERVER_IMPL_LIFETIME_BOUND
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
E &	error () USERVER_IMPL_LIFETIME_BOUND
	Return reference to the error value or throws bad_expected_access if it's not available.
const E &	error () const USERVER_IMPL_LIFETIME_BOUND
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Constructor & Destructor Documentation

expected() [1/7]

template<class S, class E>

utils::expected< S, E >::expected ( )

constexpr

Definition at line 162 of file expected.hpp.

expected() [2/7]

template<class S, class E>

utils::expected< S, E >::expected

(

const S &

success

)

Definition at line 167 of file expected.hpp.

expected() [3/7]

template<class S, class E>

utils::expected< S, E >::expected

(

S &&

success

)

Definition at line 172 of file expected.hpp.

expected() [4/7]

template<class S, class E>

utils::expected< S, E >::expected

(

const unexpected< E > &

error

)

Definition at line 177 of file expected.hpp.

expected() [5/7]

template<class S, class E>

utils::expected< S, E >::expected

(

unexpected< E > &&

error

)

Definition at line 182 of file expected.hpp.

expected() [6/7]

template<class S, class E>
requires std::is_convertible_v<G, E>

template<class G>
requires std::is_convertible_v<G, E>

utils::expected< S, E >::expected

(

const unexpected< G > &

error

)

Definition at line 189 of file expected.hpp.

expected() [7/7]

template<class S, class E>
requires std::is_convertible_v<G, E>

template<class G>
requires std::is_convertible_v<G, E>

utils::expected< S, E >::expected

(

unexpected< G > &&

error

)

Definition at line 196 of file expected.hpp.

Member Function Documentation

error() [1/2]

template<class S, class E>

const E & utils::expected< S, E >::error

(

)

const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 243 of file expected.hpp.

error() [2/2]

template<class S, class E>

E & utils::expected< S, E >::error

(

)

Return reference to the error value or throws bad_expected_access if it's not available.

Exceptions

utils::bad_expected_access

if success value is not available

Definition at line 234 of file expected.hpp.

has_value()

template<class S, class E>

bool utils::expected< S, E >::has_value ( ) const

noexcept

Check whether *this contains an expected value.

Definition at line 201 of file expected.hpp.

operator bool()

template<class S, class E>

utils::expected< S, E >::operator bool ( ) const

explicitnoexcept

Check whether *this contains an expected value.

Definition at line 206 of file expected.hpp.

value() [1/3]

template<class S, class E>

S && utils::expected< S, E >::value

(

)

&&

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 220 of file expected.hpp.

value() [2/3]

template<class S, class E>

S & utils::expected< S, E >::value

(

)

&

Return reference to the value or throws bad_expected_access if it's not available.

Exceptions

utils::bad_expected_access

if *this contain an unexpected value

Definition at line 211 of file expected.hpp.

value() [3/3]

template<class S, class E>

const S & utils::expected< S, E >::value

(

)

const &

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 225 of file expected.hpp.

---

The documentation for this class was generated from the following file:

• userver/utils/expected.hpp