std::optional

 

C++

Поддержка компилятором

Автономные и размещённые реализации

Язык

Заголовки стандартной библиотеки

Требования к именованию

Макросы тестирования функциональности (C++20)

Поддержка языка

Библиотека концептов (C++20)

Библиотека диагностики

Библиотека общих утилит

Библиотека строк

Библиотека контейнеров

Библиотека итераторов

Библиотека диапазонов (C++20)

Библиотека алгоритмов

Библиотека численных данных

Библиотека ввода/вывода

Библиотека локализаций

Регулярные выражения (C++11)

Атомарные операции (C++11)

Библиотека поддержки потоков (C++11)

Библиотека файловой системы (C++17)

Технические спецификации

Указатель символов

Внешние библиотеки

 

Библиотека утилит

Поддержка языка Поддержка типа (базовые типы, RTTI, свойства типов)     Макросы тестирования функциональности библиотеки (C++20) Управление динамической памятью Программные утилиты Обработка ошибок Поддержка сопрограмм (C++20) Вариативные функции launder (C++17) initializer_list (C++11) source_location (C++20) Трёхстороннее сравнение (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20) is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

Общие утилиты Дата и время Объекты функции bitset Библиотека форматирования (C++20) hash (C++11) integer_sequence (C++14) Операторы отношения (устарело в C++20) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= Целочисленные функции сравнения cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)   cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) Операции обмена и типа swap ranges::swap (C++20) exchange (C++14) declval (C++11) forward (C++11) move (C++11) move_if_noexcept (C++11) as_const (C++17) to_underlying (C++23) Общие лексические типы pair tuple (C++11) apply (C++17) make_from_tuple (C++17) optional (C++17) any (C++17) variant (C++17) Элементарные преобразования строк to_chars (C++17) from_chars (C++17) chars_format (C++17) Stacktrace stacktrace_entry (C++23) basic_stacktrace (C++23)

 

std::optional

Функции-элементы

optional::optional

optional::~optional

optional::operator=

Наблюдатели

optional::operator->optional::operator*

optional::operator booloptional::has_value

optional::value

optional::value_or

Модификаторы

optional::emplace

optional::swap

optional::reset

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

operator==operator!=operator<operator<=operator>operator>=operator<=> (C++20)

make_optional

swap

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

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

hash

nullopt_t

in_place_t

bad_optional_access

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

nullopt

in_place

 

Определено в заголовочном файле <optional>
template< class T > class optional;		(начиная с C++17)

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

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

Любой экземпляр optional<T> в любой данный момент времени либо содержит значение, либо пуст.

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

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

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

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

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

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

Нет необязательных ссылок; программа некорректна, если она создаёт экземпляр optional со ссылочным типом. В качестве альтернативы для хранения ссылки может использоваться optional из std::reference_wrapper типа T. Кроме того, программа некорректна, если она создаёт экземпляр optional с (возможно, cv-квалифицированными) типами тегов std::nullopt_t или std::in_place_t.

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

T

—

тип значения, для которого нужно управлять состоянием инициализации. Тип должен быть Destructible (в частности, типы массивов не допускаются).

Типы-элементы

Тип	Определине
value_type	T

Фукции-элементы

(конструктор)	создаёт необязательный объект (public функция-элемент)
(деструктор)	уничтожает содержащееся значение, если оно есть (public функция-элемент)
operator=	присваивает содержимое (public функция-элемент)
Наблюдатели
operator-> operator*	получает доступ к содержащемуся значению (public функция-элемент)
operator bool has_value	проверяет, содержит ли объект значение (public функция-элемент)
value	возвращает содержащееся значение (public функция-элемент)
value_or	возвращает содержащееся значение, если доступно, иначе другое значение (public функция-элемент)
Модификаторы
swap	обменивается содержимым (public функция-элемент)
reset	уничтожает любое содержащееся значение (public функция-элемент)
emplace	создаёт содержащееся значение на месте (public функция-элемент)

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

operator== operator!= operator< operator<= operator> operator>= operator<=> (C++17) (C++17) (C++17) (C++17) (C++17) (C++17) (C++20)	сравнивает объекты optional (шаблон функции)
make_optional (C++17)	создаёт объект optional (шаблон функции)
std::swap(std::optional) (C++17)	специализация алгоритма std::swap (шаблон функции)

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

std::hash<std::optional> (C++17)	специализация алгоритма std::hash (специализация шаблона класса)
nullopt_t (C++17)	индикатор типа optional с неинициализированным состоянием (класс)
bad_optional_access (C++17)	исключение, указывающее на доступ на проверку к optional, не содержащему значения (класс)

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

nullopt (C++17)	объект типа nullopt_t (константа)
in_place in_place_type in_place_index in_place_t in_place_type_t in_place_index_t (C++17)	метка конструирования на месте (шаблон класса)

Пример

Запустить этот код

#include <string>
#include <functional>
#include <iostream>
#include <optional>
 
// optional может использоваться как возвращаемый тип фабрики, которая может дать сбой
std::optional<std::string> create(bool b) {
    if (b)
        return "Годзилла";
    return {};
}
 
// std::nullopt можно использовать для создания любого (пустого) std::optional
auto create2(bool b) {
    return b ? std::optional<std::string>{"Годзилла"} : std::nullopt;
}
 
// std::reference_wrapper может использоваться для возврата ссылки
auto create_ref(bool b) {
    static std::string value = "Годзилла";
    return b ? std::optional<std::reference_wrapper<std::string>>{value}
             : std::nullopt;
}
 
int main()
{
    std::cout << "create(false) вернула "
              << create(false).value_or("пусто") << '\n';
 
    // фабричные функции с необязательным возвратом можно использовать как условия
    // while и if
    if (auto str = create2(true)) {
        std::cout << "create2(true) вернула " << *str << '\n';
    }
 
    if (auto str = create_ref(true)) {
        // использование get() для доступа к значению reference_wrapper
        std::cout << "create_ref(true) вернула " << str->get() << '\n';
        str->get() = "Mothra";
        std::cout << "модификация изменила её на " << str->get() << '\n';
    }
}

Вывод:

create(false) вернула пусто
create2(true) вернула Годзилла
create_ref(true) вернула Годзилла
модификация изменила её на Mothra

Смотрите также

variant (C++17)	типобезопасное размеченное объединение (шаблон класса)
any (C++17)	объекты, содержащие экземпляры любого CopyConstructible типа. (класс)