std::optional::value

constexpr T& value() &;
constexpr const T & value() const &;

constexpr T&& value() &&;
constexpr const T&& value() const &&;

If *this contains a value, returns a reference to the contained value.

Otherwise, throws a std::bad_optional_access exception.

Parameters

(none).

Return value

A reference to the contained value.

Exceptions

std::bad_optional_access if *this does not contain a value.

Notes

The dereference operator operator*() does not check if this optional contains a value, which may be more efficient than value().

Example

#include <optional>
#include <iostream>
int main()
{
    std::optional<int> opt = {};
 
    try {
        int n = opt.value();
    } catch(const std::logic_error& e) {
        std::cout << e.what() << '\n';
    }
}

optional<T>::value: not engaged

See also