std::unexpected

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

工具库

语言支持 类型支持（基本类型、RTTI） 库特性测试宏 (C++20) 程序工具 变参函数 initializer_list (C++11) is_constant_evaluated (C++20) is_within_lifetime (C++26) source_location (C++20) 协程支持 (C++20) 契约支持 (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)

 

std::expected

成员函数

expected::expected

expected::~expected

expected::operator=

观察器

expected::operator->expected::operator*

expected::operator boolexpected::has_value

expected::value

expected::error

expected::value_or

expected::error_or

Monadic operations

expected::and_then

expected::or_else

expected::transform

expected::transform_error

修改器

expected::emplace

expected::swap

非成员函数

operator==(std::expected)

swap(std::expected)

辅助类

unexpected

bad_expected_access

unexpect_tunexpect

 

定义于头文件 <expected>
template< class E > class unexpected;		(C++23 起)

类模板 std::unexpected 表示存储在 std::expected 中的意外值。特别是，std::expected 具有以 std::unexpected 作为单个参数的构造函数，该构造函数创建一个包含意外值的 expected 对象。

如果程序使用非对象类型、数组类型、std::unexpected 的特化或 cv 限定类型实例化 unexpected，则该程序格式错误。

模板参数

E

-

意外值的类型。该类型不能是数组类型、非对象类型、std::unexpected 的特化或 cv 限定类型。

成员函数

(构造函数)	构造 unexpected 对象 (公开成员函数)
(析构函数) (隐式声明)	销毁 unexpected 对象及其存储的值 (公开成员函数)
operator= (隐式声明)	赋值存储的值 (公开成员函数)
error	访问存储的值 (公开成员函数)
swap	交换存储的值 (公开成员函数)

非成员函数

operator== (C++23)	比较存储的值 (函数模板)
swap(std::unexpected) (C++23)	特化 std::swap 算法 (函数模板)

std::unexpected::unexpected

constexpr unexpected( const unexpected& ) = default;	(1)
constexpr unexpected( unexpected&& ) = default;	(2)
template< class Err = E > constexpr explicit unexpected( Err&& e );	(3)
template< class... Args > constexpr explicit unexpected( std::in_place_t, Args&&... args );	(4)
template< class U, class... Args > constexpr explicit unexpected( std::in_place_t,                                std::initializer_list<U> il, Args&&... args );	(5)

构造 std::unexpected 对象。

1,2) 拷贝/移动构造函数。分别拷贝或移动存储的值。

3) 构造存储的值，如同通过 直接初始化 类型为 E 的值，从 std::forward<Err>(e) 构造。

• 此重载仅在以下情况参与重载决议：
  • std::is_same_v<std::remove_cvref_t<Err>, unexpected> 为 false，且
  • std::is_same_v<std::remove_cvref_t<Err>, std::in_place_t> 为 false，且
  • std::is_constructible_v<E, Err> 为 true。

4) 构造存储的值，如同通过 直接初始化 类型为 E 的值，从参数 std::forward<Args>(args)... 构造。

• 此重载仅在 std::is_constructible_v<E, Args...> 为 true 时参与重载决议。

5) 构造存储的值，如同通过 直接初始化 类型为 E 的值，从参数 il, std::forward<Args>(args)... 构造。

• 此重载仅在 std::is_constructible_v<E, std::initializer_list<U>&, Args...> 为 true 时参与重载决议。

参数

e	-	用于初始化包含值的值
args...	-	用于初始化包含值的参数
il	-	用于初始化包含值的初始化列表

异常

抛出由 E 的构造函数抛出的任何异常。

std::unexpected::error

constexpr const E& error() const& noexcept; constexpr E& error() & noexcept; constexpr const E&& error() const&& noexcept; constexpr E&& error() && noexcept;

返回对存储值的引用。

std::unexpected::swap

constexpr void swap( unexpected& other ) noexcept(std::is_nothrow_swappable_v<E>);

交换存储的值，如同通过 using std::swap; swap(error(), other.error());。

如果 std::is_swappable_v<E> 为 false，则程序格式错误。

operator==(std::unexpected)

template< class E2 > friend constexpr bool operator==( unexpected& x, std::unexpected<E2>& y );

比较存储的值，如同通过 return x.error() == y.error()。

如果表达式 x.error() == e.error() 格式不正确，或其结果不可转换为 bool，则程序格式错误。

此函数对普通的 非限定查找 或 限定查找 不可见，并且只有在 std::unexpected<E> 是参数的关联类时才能通过 参数依赖查找 找到。

swap(std::unexpected)

friend constexpr void swap( unexpected& x, unexpected& y ) noexcept(noexcept(x.swap(y)));

等效于 x.swap(y)。

此重载仅在 std::is_swappable_v<E> 为 true 时参与重载决议。

此函数对普通的 非限定查找 或 限定查找 不可见，并且只有在 std::unexpected<E> 是参数的关联类时才能通过 参数依赖查找 找到。

推导指南

template< class E > unexpected(E) -> unexpected<E>;		(C++23 起)

为 unexpected 提供了 推导指南，以允许从构造函数参数进行推导。

注记

在 C++17 之前，名称 std::unexpected 表示当动态异常规范被违反时，C++ 运行时调用的函数。

示例

运行此代码

#include <expected>
#include <iostream>
 
enum class error
{
    compile_time_error,
    runtime_error
};
 
[[nodiscard]] auto unexpected_runtime_error() -> std::expected<int, error>
{
    return std::unexpected(error::runtime_error);
}
 
int main()
{
    std::expected<double, int> ex = std::unexpected(3);
 
    if (!ex)
        std::cout << "ex contains an error value\n";
 
    if (ex == std::unexpected(3))
        std::cout << "The error value is equal to 3\n";
 
    const auto e = unexpected_runtime_error();
 
    e.and_then([](const auto& e) -> std::expected<int, error>
    {
        std::cout << "and_then: " << int(e); // not printed
        return {};
    })
    .or_else([](const auto& e) -> std::expected<int, error>
    {
        std::cout << "or_else: " << int(e); // prints this line
        return {};
    });
}

输出

ex contains an error value
The error value is equal to 3
or_else: 1

参阅

(构造函数)	构造 expected 对象 (public member function)
operator== (C++23)	比较 expected 对象 (function template)