Namespaces
Variants

std:: bad_optional_access

From cppreference.net
C++
Utilities library
std::optional
Defined in header <optional>
class bad_optional_access : public std:: exception
(since C++17)

Defines a type of object to be thrown by std::optional::value when accessing an optional object that does not contain a value.

All member functions of std::bad_optional_access are constexpr : it is possible to create and use std::bad_optional_access objects in the evaluation of a constant expression.

However, std::bad_optional_access objects generally cannot be constexpr , because any dynamically allocated storage must be released in the same evaluation of constant expression.

(since C++26)
cpp/error/exception std-bad optional access-inheritance-lwg2806.svg

Inheritance diagram

Contents

Member functions

(constructor)
constructs a new bad_optional_access object
(public member function)
operator=
replaces the bad_optional_access object
(public member function)
what
returns the explanatory string
(public member function)

std::bad_optional_access:: bad_optional_access

bad_optional_access ( ) noexcept ;
(1) (since C++17)
(constexpr since C++26)
bad_optional_access ( const bad_optional_access & other ) noexcept ;
(2) (since C++17)
(constexpr since C++26)

Constructs a new bad_optional_access object with an implementation-defined null-terminated byte string which is accessible through what() .

1) Default constructor.
2) Copy constructor. If * this and other both have dynamic type std::bad_optional_access then std:: strcmp ( what ( ) , other. what ( ) ) == 0 .

Parameters

other - another exception object to copy

std::bad_optional_access:: operator=

bad_optional_access & operator = ( const bad_optional_access & other ) noexcept ;
(since C++17)
(constexpr since C++26)

Assigns the contents with those of other . If * this and other both have dynamic type std::bad_optional_access then std:: strcmp ( what ( ) , other. what ( ) ) == 0 after assignment.

Parameters

other - another exception object to assign with

Return value

* this

std::bad_optional_access:: what

virtual const char * what ( ) const noexcept ;
(since C++17)
(constexpr since C++26)

Returns the explanatory string.

Return value

Pointer to an implementation-defined null-terminated string with explanatory information. The string is suitable for conversion and display as a std::wstring . The pointer is guaranteed to be valid at least until the exception object from which it is obtained is destroyed, or until a non-const member function (e.g. copy assignment operator) on the exception object is called.

The returned string is encoded with the ordinary literal encoding during constant evaluation.

(since C++26)

Notes

Implementations are allowed but not required to override what() .

Inherited from std:: exception

Member functions

[virtual]
destroys the exception object
(virtual public member function of std::exception )
[virtual]
returns an explanatory string
(virtual public member function of std::exception )

Notes

Feature-test macro Value Std Feature
__cpp_lib_constexpr_exceptions 202502L (C++26) constexpr std::bad_optional_access

Example

Run this code 
#include <iostream>
#include <optional>
int main()
{
    std::optional<int> opt; // creates an empty optional
    try
    {
        [[maybe_unused]] auto x = opt.value(); // throws
    }
    catch (const std::bad_optional_access& ex)
    {
        std::cout << ex.what() << '\n';
    }
}

Possible output: 

bad optional access

See also

(C++23)
exception indicating checked access to an expected that contains an unexpected value
(class template)
(C++17)
exception thrown on invalid accesses to the value of a variant
(class)