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()。
|
|
(C++26 起) |
不存在可选的引用、函数、数组或 cv void：如果以这些类型实例化 optional，那么程序非良构。另外，如果以（可有 cv 限定的）标签类型 std::nullopt_t 或 std::in_place_t 实例化 optional，那么程序非良构。
模板形参
| T | - | 要为之管理初始化状态的值的类型。该类型必须满足可析构 (Destructible) 的要求。（特别是不允许数组和引用类型） |
成员类型
| 成员名称 | 定义 |
value_type
|
T
|
iterator (C++26 起)
|
由实现定义的老式随机访问迭代器 (LegacyRandomAccessIterator) 、常量表达式迭代器 (ConstexprIterator) 和 contiguous_iterator，其 value_type 和 reference 分别为 std::remove_cv_t<T> 和 T&。
|
const_iterator (C++26 起)
|
由实现定义的老式随机访问迭代器 (LegacyRandomAccessIterator) 、常量表达式迭代器 (ConstexprIterator) 和 contiguous_iterator，其 value_type 和 reference 分别为 std::remove_cv_t<T> 和 const T&。
|
针对容器 (Container) 的迭代器的要求同样适用于 optional 的 iterator 类型。
成员函数
构造 optional 对象 (公开成员函数) | |
| 销毁容纳的值（如果存在） (公开成员函数) | |
| 对内容赋值 (公开成员函数) | |
迭代器 | |
| (C++26) |
返回指向起始的迭代器 (公开成员函数) |
| (C++26) |
返回指向末尾的迭代器 (公开成员函数) |
观察器 | |
| 访问所含值 (公开成员函数) | |
| 检查对象是否含值 (公开成员函数) | |
| 返回所含值 (公开成员函数) | |
| 在所含值可用时返回它，否则返回另一个值 (公开成员函数) | |
单子式操作 | |
| (C++23) |
在所含值存在时返回对其应用给定的函数的结果，否则返回空的 optional (公开成员函数) |
| (C++23) |
在所含值存在时返回含有变换后的所含值的 optional，否则返回空的 optional (公开成员函数) |
| (C++23) |
在 optional 含值时返回自身，否则返回给定函数的结果 (公开成员函数) |
修改器 | |
| 交换内容 (公开成员函数) | |
| 销毁任何所含值 (公开成员函数) | |
| 原位构造所含值 (公开成员函数) | |
非成员函数
| (C++17)(C++17)(C++17)(C++17)(C++17)(C++17)(C++20) |
比较 optional 对象 (函数模板) |
| (C++17) |
创建一个 optional 对象 (函数模板) |
| (C++17) |
特化 std::swap 算法 (函数模板) |
辅助类
| (C++17) |
std::optional 的散列支持 (类模板特化) |
| (C++17) |
不含值的 std::optional 的指示器 (类) |
| (C++17) |
指示进行了到不含值的 optional 的有检查访问的异常 (类) |
辅助对象
| (C++17) |
nullopt_t 类型的对象 (常量) | |
| 就地构造的标签 (标签) |
| template< class T > inline constexpr bool ranges::enable_view<std::optional<T>> = true; |
(C++26 起) | |
这个 ranges::enable_view 特化使得 optional 满足 view。
| template< class T > inline constexpr auto format_kind<std::optional<T>> = range_format::disabled; |
(C++26 起) | |
这个 format_kind 特化禁用 optional 的范围格式化支持。
推导指引
注解
| 功能特性测试宏 | 值 | 标准 | 功能特性 |
|---|---|---|---|
__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 可用作可能失败的工厂的返回类型 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
参阅
| (C++17) |
类型安全的可辨识联合体 (类模板) |
| (C++17) |
可保有任何可复制构造 (CopyConstructible) 类型的实例的对象。 (类) |
含有具有指定值的单个元素的 view (类模板) (定制点对象) | |
无元素的空 view (类模板) (变量模板) |