std::unexpected

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

并发支持库 (C++11)

技术规范

符号索引

外部库

 

工具库

语言支持 类型支持（基本类型、 RTTI） 库功能特性测试宏 (C++20) 动态内存管理 程序工具 协程支持 (C++20) 变参数函数 is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) 三路比较 (C++20) 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_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(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 与类型运算 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::expected

成员函数

expected::expected

expected::~expected

expected::operator=

观察器

expected::operator->expected::operator*

expected::operator boolexpected::has_value

expected::value

expected::error

expected::value_or

单子函数

expected::and_then

expected::or_else

expected::transform

expected::transform_error

修改器

expected::emplace

expected::swap

非成员函数

operator==

swap

辅助类

unexpected

bad_expected_access

unexpect_tunexpect

 

在标头 <expected> 定义
template< class E > class unexpected;

类模板 std::unexpected 代表一个 std::expected 中存储的不期待的值。特别地， std::expected 有一个接受 std::unexpected 为唯一参数的构造函数，该构造函数创建一个含有不期待值的 expected 对象。

用非对象类型，数组类型， std::unexpected 的特化或有 cv 限定的类型实例化 unexpected 的程序非良构。

模板形参

E

-

不期待的值的类型，该类型不能是非对象类型，数组类型， std::unexpected 的特化或有 cv 限定的类型

成员函数

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

非成员函数

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

std::unexpected::unexpected

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

构造 std::unexpected 对象。

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

3) 如同从 std::forward<Err>(e) 直接初始化 类型为 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) 如同从 std::forward<Args>(args)... 直接初始化 类型为 E 的值一样构造存储的值。

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

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

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

参数

e	-	初始化所含值所用的值
args...	-	初始化所含值所用的参数
il	-	初始化所含值所用的 initializer_list

异常

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

std::unexpected::error

constexpr const E& error() const& noexcept; constexpr E& error() & noexcept; constexpr const E&& error() const&& noexcept; constexpr E&& error() && noexcept;		(C++23 起)

返回到存储的值的引用。

std::unexpected::swap

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

如同 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 );		(C++23 起)

如同 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)));		(C++23 起)

等价于 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>
 
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";
    }
}

输出：

ex contains an error value
The error value is equal to 3

参阅

(构造函数)	构造 expected 对象 (公开成员函数)
operator==	比较 expected 对象 (函数模板)