std::optional

来自cppreference.com
< cpp‎ | utility
 
 
工具库
类型支持(基本类型、 RTTI 、类型特性)
动态内存管理
错误处理
程序工具
变参数函数
日期和时间
函数对象
(C++11)
关系运算符
optionalanyvariant (C++17)
optional
pair 与 tuple
(C++11)
(C++17)
swap 、 forward 与 move
(C++14)
(C++11)
(C++11)
初等字符串转换
(C++17)
(C++17)
类型运算
(C++11)
(C++17)
 
 
定义于头文件 <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 对象初始化/赋值。

无 optional 引用:若以引用类型实例化 optional 则程序为病式。另外,若以标签类型 std::nullopt_tstd::in_place_t 实例化 optional 则程序为病式。

目录

[编辑] 模板形参

T - 要为之管理状态的值的类型。该类型必须满足可析构 (Destructible) 的要求。

[编辑] 成员类型

成员类型 定义
value_type T

[编辑] 成员函数

构造optional对象
(公开成员函数) [编辑]
销毁容纳的值,若存在
(公开成员函数) [编辑]
对内容赋值
(公开成员函数) [编辑]
观察器
访问所含值
(公开成员函数) [编辑]
检查对象是否含值
(公开成员函数) [编辑]
返回容纳的值
(公开成员函数) [编辑]
若可用则返回容纳的值,否则返回另一个值
(公开成员函数) [编辑]
修改器
交换内容
(公开成员函数) [编辑]
销毁任何所含值
(公开成员函数) [编辑]
原位构造所含值
(公开成员函数) [编辑]

[编辑] 非成员函数

比较 optional 对象
(函数模板) [编辑]
创建一个 optional 对象
(函数模板) [编辑]
特化 std::swap 算法
(函数) [编辑]

[编辑] 辅助类

特化 std::hash 算法
(类模板特化) [编辑]
(C++17)
带未初始化状态的optional类型的指示器
(类) [编辑]
指示到不含值的 optional 的有检查访问的异常
(类) [编辑]

[编辑] 辅助对象

(C++17)
nullopt_t 类型对象
(常量) [编辑]
原位构造标签
(类模板) [编辑]

[编辑] 推导指引

[编辑] 示例

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

输出:

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

[编辑] 参阅

(C++17 起)
有类型安全辨别的联合体
(类模板) [编辑]
(C++17 起)
保有任何可复制构造 (CopyConstructible) 类型实例的对象。
(类) [编辑]