std::optional

template< class T >
class optional;

Шаблон класса std::optional управляет необязательным хранимым значением, то есть значением, которое может присутствовать или отсутствовать.

Частый вариант использования optional — возвращаемое значение функции, выполнение которой может завершиться неудачей. В отличие от других подходов, таких как std::pair<T,bool>, optional хорошо работает с объектами, создание которых требует значительных затрат, и делает код более понятным, поскольку намерение выражено явно.

В любой момент времени экземпляр optional либо содержит значение, либо не содержит значения.

Если optional содержит значение, гарантируется, что оно вложено в объект optional. Таким образом, объект optional моделирует объект, а не указатель, несмотря на то, что определены operator*() и operator->().

При контекстном преобразовании в bool объекта типа optional<T> результатом преобразования будет true, если объект содержит значение, и false, если не содержит.

Объект optional содержит значение в следующих случаях:

• Объект инициализирован значением типа T или другим optional, содержащим значение, либо ему присвоено такое значение.

Объект не содержит значения в следующих случаях:

• Объект инициализирован по умолчанию.
• Объект инициализирован значением типа std::nullopt_t или объектом optional, не содержащим значения, либо ему присвоено такое значение.
• Вызвана функция-член reset().

Не существует необязательных ссылок, функций, массивов или (возможно, cv-квалифицированного) типа void; программа некорректна, если в ней инстанцируется optional с таким типом. Кроме того, программа некорректна, если в ней инстанцируется optional с типами-тегами std::nullopt_t или std::in_place_t (возможно, cv-квалифицированными).

Параметры шаблона

Вложенные типы

Все требования к типам итераторов Container также применяются к типу iterator класса optional.

Поля данных

Функции-члены

Функции, не являющиеся членами

Вспомогательные классы

Вспомогательные элементы

Вспомогательные специализации

template< class T >
constexpr bool ranges::enable_view<std::optional<T>> = true;

Эта специализация ranges::enable_view позволяет optional удовлетворять требованиям view.

template< class T >
constexpr auto format_kind<std::optional<T>> = range_format::disabled;

Эта специализация format_kind отключает поддержку форматирования диапазонов для optional.

Руководства по выводу типов

Примечания

Пример

#include <iostream>
#include <optional>
#include <string>
 
// optional can be used as the return type of a factory that may fail
std::optional<std::string> create(bool b)
{
    if (b)
        return "Godzilla";
    return {};
}

// std::nullopt can be used to create any (empty) std::optional
auto create2(bool b)
{
    return b ? std::optional<std::string>{"Godzilla"} : std::nullopt;
}

int main()
{
    std::cout << "create(false) returned "
              << create(false).value_or("empty") << '\n';
    
    // optional-returning factory functions are usable as conditions of while and if
    if (auto str = create2(true))
        std::cout << "create2(true) returned " << *str << '\n';
}

create(false) returned empty
create2(true) returned Godzilla

Отчёты об ошибках

Следующие отчёты об ошибках, изменяющие поведение, были применены ретроактивно к ранее опубликованным стандартам C++.

См. также