std::optional

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名需求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用程序库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

执行支持库 (C++26)

技术规范

符号索引

外部库

 

实用程序库

语言支持 类型支持 (基本类型，RTTI) 库特性测试宏 (C++20) 动态内存管理 程序实用程序 协程支持 (C++20) 可变参数函数 is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) 调试支持 is_debugger_present (C++26) breakpoint_if_debugging (C++26) breakpoint (C++26) 三向比较 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_ltis_lteq (C++20)(C++20)(C++20) is_neqis_gtis_gteq (C++20)(C++20)(C++20)

通用实用程序 日期和时间 函数对象 格式化库 (C++20) bitset hash (C++11) 关系运算符 (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) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) 通用词汇类型 pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23) 基本字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

std::optional

成员函数

optional::optional

optional::~optional

optional::operator=

观察者

optional::operator->optional::operator*

optional::operator booloptional::has_value

optional::value

optional::value_or

迭代器

optional::begin (C++26)

optional::end (C++26)

单子操作

optional::and_then (C++23)

optional::transform (C++23)

optional::or_else (C++23)

修饰符

optional::emplace

optional::swap

optional::reset

非成员函数

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

make_optional

swap(std::optional)

推导指南

辅助类

hash<std::optional>

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 进行初始化/赋值。

在以下情况下，该对象不包含一个值

• 该对象使用默认值进行初始化。
• 该对象使用类型 std::nullopt_t 的值或一个不包含一个值的 optional 对象进行初始化/赋值。
• 调用了成员函数 reset()。

optional 对象是一个view，如果包含一个值，则包含一个元素；否则，如果不包含一个值，则包含零个元素。包含元素的生存期绑定到该对象。

(自 C++26 起)

没有可选引用、函数、数组或cv void；如果程序使用这种类型实例化 optional，则该程序格式错误。此外，如果程序使用（可能被 cv 限定的）标签类型 std::nullopt_t 或 std::in_place_t 实例化 optional，则该程序格式错误。

模板参数

T

-

要管理初始化状态的值的类型。该类型必须满足 可销毁 的要求（特别是，不允许使用数组和引用类型）。

成员类型

成员名称	定义
value_type	T
iterator (自 C++26 起)	实现定义的 传统随机访问迭代器、常量表达式迭代器 和 contiguous_iterator，其 value_type 和 reference 分别为 std::remove_cv_t<T> 和 T&。
const_iterator (自 C++26 起)	实现定义的 传统随机访问迭代器、常量表达式迭代器 和 contiguous_iterator，其 value_type 和 reference 分别为 std::remove_cv_t<T> 和 const T&。

对 容器 的迭代器类型的所有要求也适用于 optional 的 iterator 类型。

成员函数

(构造函数)	构造 optional 对象 (公共成员函数)
(析构函数)	如果存在，则销毁所包含的值 (公共成员函数)
operator=	赋值内容 (公共成员函数)
迭代器
begin (C++26)	返回指向开头的迭代器 (公共成员函数)
end (C++26)	返回指向末尾的迭代器 (公共成员函数)
观察者
operator->operator*	访问所包含的值 (公共成员函数)
operator boolhas_value	检查对象是否包含值 (公共成员函数)
value	返回所包含的值 (公共成员函数)
value_or	如果可用，返回所包含的值，否则返回另一个值 (公共成员函数)
单子操作
and_then (C++23)	如果存在，返回给定函数对所包含值的调用结果，否则返回一个空的 optional (公共成员函数)
transform (C++23)	如果存在，返回一个包含已转换的所包含值的 optional，否则返回一个空的 optional (公共成员函数)
or_else (C++23)	如果包含值，返回 optional 本身，否则返回给定函数的结果 (公共成员函数)
修饰符
swap	交换内容 (公共成员函数)
reset	销毁任何包含的值 (公共成员函数)
emplace	就地构造所包含的值 (公共成员函数)

非成员函数

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::optional 的哈希支持 (类模板专门化)
nullopt_t (C++17)	不包含值的 std::optional 的指示器 (类)
bad_optional_access (C++17)	指示对不包含值的可选值进行检查访问的异常 (类)

辅助程序

nullopt (C++17)	nullopt_t 类型的对象 (常量)
in_placein_place_typein_place_indexin_place_tin_place_type_tin_place_index_t (C++17)	就地构造标记 (标记)

辅助专门化

template< class T > constexpr bool ranges::enable_view<std::optional<T>> = true;		(自 C++26 起)

这种 ranges::enable_view 的专门化使 optional 满足 view 的要求。

template< class T > constexpr auto format_kind<std::optional<T>> = range_format::disabled;		(自 C++26 起)

这种 format_kind 的专门化禁用了 optional 的 范围格式化支持。

注释

功能测试 宏	值	Std	功能
__cpp_lib_optional	201606L	(C++17)	std::optional
	202106L	(C++20) (DR20)	完全 constexpr
	202110L	(C++23)	单子操作
__cpp_lib_optional_range_support	202406L	(C++26)	std::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

另请参阅

variant (C++17)	类型安全的区分联合 (类模板)
any (C++17)	保存任何 CopyConstructible 类型的实例的对象 (类)
ranges::single_viewviews::single (C++20)	包含指定值的单个元素的 view (类模板) (自定义点对象)
ranges::empty_viewviews::empty (C++20)	一个没有元素的空 view (类模板) (变量模板)