std::optional

在标头 `<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：如果以引用类型实例化 optional，那么程序非良构。另外，如果以（可有 cv 限定的）标签类型 std::nullopt_t 或 std::in_place_t 实例化 optional，那么程序非良构。

模板形参

T

-

要为之管理状态的值的类型。该类型必须满足可析构 (Destructible) 的要求。（特别是不允许数组类型）

成员类型

成员类型	定义
`value_type`	`T`

成员函数

(构造函数)	构造 `optional` 对象 (公开成员函数)
(析构函数)	销毁容纳的值（如果存在） (公开成员函数)
operator=	对内容赋值 (公开成员函数)
观察器
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)	带未初始化状态的 `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)	原位构造标签 (类模板)

推导指引

注解

功能特性测试宏	值	标准	注释
`__cpp_lib_optional`	201606L	(C++17)	`std::optional`
`__cpp_lib_optional`	202106L	(C++20)	完全 constexpr
`__cpp_lib_optional`	202110L	(C++23)	单子操作

示例

运行此代码

#include <iostream>
#include <optional>
#include <string>
 
// optional 可用作可能失败的工厂的返回类型
std::optional<std::string> create(bool b)
{
    if (b)
        return "Godzilla";
    return {};
}
 
// 能用 std::nullopt 创建任何（空的） std::optional
auto create2(bool b)
{
    return b ? std::optional<std::string>{"Godzilla"} : std::nullopt;
}
 
int main()
{
    std::cout << "create(false) 返回 "
              << create(false).value_or("empty") << '\n';
 
    // 返回 optional 的工厂函数可用作 while 和 if 的条件
    if (auto str = create2(true))
        std::cout << "create2(true) 返回 " << *str << '\n';
}

输出：

create(false) 返回 empty
create2(true) 返回 Godzilla

参阅

variant (C++17)	类型安全的可辨识联合体 (类模板)
any (C++17)	可保有任何可复制构造 (CopyConstructible) 类型的实例的对象。 (类)

编译器支持
自立实现与有宿主实现
语言
标准库
标准库标头
具名要求
功能特性测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用工具库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
技术规范
符号索引
外部库