std::expected<T,E>::expected

 

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

 

Main template
constexpr expected();	(1)	(C++23 起)
constexpr expected( const expected& other );	(2)	(C++23 起)
constexpr expected( expected&& other ) noexcept(/* see below */);	(3)	(C++23 起)
template< class U, class G > constexpr expected( const expected<U, G>& other );	(4)	(C++23 起) (conditionally explicit)
template< class U, class G > constexpr expected( expected<U, G>&& other );	(5)	(C++23 起) (conditionally explicit)
template< class U = std::remove_cv_t<T> > constexpr explicit(!std::is_convertible_v<U, T>) expected( U&& v );	(6)	(C++23 起)
template< class G > constexpr explicit(!std::is_convertible_v<const G&, E>)     expected( const std::unexpected<G>& e );	(7)	(C++23 起)
template< class G > constexpr explicit(!std::is_convertible_v<G, E>)     expected( std::unexpected<G>&& e );	(8)	(C++23 起)
template< class... Args > constexpr explicit expected( std::in_place_t, Args&&... args );	(9)	(C++23 起)
template< class U, class... Args > constexpr explicit     expected( std::in_place_t,               std::initializer_list<U> il, Args&&... args );	(10)	(C++23 起)
template< class... Args > constexpr explicit expected( std::unexpect_t, Args&&... args );	(11)	(C++23 起)
template< class U, class... Args > constexpr explicit     expected( std::unexpect_t,               std::initializer_list<U> il, Args&&... args );	(12)	(C++23 起)
void 偏特化
constexpr expected();	(13)	(C++23 起)
constexpr expected( const expected& other );	(14)	(C++23 起)
constexpr expected( expected&& other )     noexcept(std::is_nothrow_move_constructible_v<E>);	(15)	(C++23 起)
template< class U, class G > constexpr explicit(!std::is_convertible_v<const G&, E>)     expected( const expected<U, G>& other );	(16)	(C++23 起)
template< class U, class G > constexpr explicit(!std::is_convertible_v<G, E>)     expected( expected<U, G>&& other );	(17)	(C++23 起)
template< class G > constexpr explicit(!std::is_convertible_v<const G&, E>)     expected( const std::unexpected<G>& e );	(18)	(C++23 起)
template< class G > constexpr explicit(!std::is_convertible_v<G, E>)     expected( std::unexpected<G>&& e );	(19)	(C++23 起)
template< class... Args > constexpr explicit expected( std::in_place_t );	(20)	(C++23 起)
template< class... Args > constexpr explicit expected( std::unexpect_t, Args&&... args );	(21)	(C++23 起)
template< class U, class... Args > constexpr explicit     expected( std::unexpect_t,               std::initializer_list<U> il, Args&&... args );	(22)	(C++23 起)

构造一个新的 expected 对象。

参数

其他	-	另一个 expected 对象，其包含的值被复制
e	-	std::unexpected 对象，其包含的值被复制
v	-	用于初始化包含值的值
args	-	用于初始化包含值的参数
il	-	用于初始化包含值的初始化列表

效果

主模板构造函数

重载	初始化 方法	初始化器用于...		has_value() 构造后
		预期值	非预期值
(1)	值	(空)	-	true
(2)	直接 (非列表)	*other	other.error()	other.has_value() 如果为 true，则只初始化预期值。 如果为 false，则只初始化非预期值。
(3)		std::move(*other)	std::move(other.error())
(4)		std::forward<const U&>     (*other)	std::forward<const G&>     (other.error())
(5)		std::forward<U>(*other)	std::forward<G>     (other.error())
(6)		std::forward<U>(v)	-	true
(7)		-	std::forward<const G&>     (e.error())	false
(8)			std::forward<G>(e.error())
(9)		std::forward<Args>(args)...	-	true
(10)		il, std::forward<Args>(args)...
(11)		-	std::forward<Args>(args)...	false
(12)			il, std::forward<Args>(args)...

void 部分特化构造函数

重载	初始化方法	非预期值的初始化器	has_value() 构造后
(13)	不适用	-	true
(14)	直接（非列表）	rhs.error()	other.has_value() 如果为 false，则初始化非预期值。
(15)		std::move(rhs.error)
(16)		std::forward<const G&>(rhs.error())
(17)		std::forward<G>(rhs.error())
(18)		std::forward<const G&>(e.error())	false
(19)		std::forward<G>(e.error())
(20)	不适用	-	true
(21)	直接（非列表）	std::forward<Args>(args)...	false
(22)		il, std::forward<Args>(args)...

约束和补充信息

主模板构造函数

1) 仅当 std::is_default_constructible_v<T> 为 true 时，此重载才参与重载决议。

2) 除非 std::is_copy_constructible_v<T> 和 std::is_copy_constructible_v<E> 都为 true，否则此构造函数被定义为删除。

如果 std::is_trivially_copy_constructible_v<T> 和 std::is_trivially_copy_constructible_v<E> 都为 true，则此构造函数是平凡的。

3) 仅当 std::is_move_constructible_v<T> 和 std::is_move_constructible_v<E> 都为 true 时，此重载才参与重载决议。

如果 std::is_trivially_move_constructible_v<T> 和 std::is_trivially_move_constructible_v<E> 都为 true，则此构造函数是平凡的。

4,5) 仅当满足以下所有条件时，这些重载才参与重载决议

• 对于重载 (4)，std::is_constructible_v<T, const U&> 和 std::is_constructible_v<E, const G&> 都为 true。
• 对于重载 (5)，std::is_constructible_v<T, U> 和 std::is_constructible_v<E, G> 都为 true。
• 如果 T 不是（可能 cv 限定的）bool，则以下 8 个值都为 false
  • std::is_constructible_v<T, std::expected<U, G>&>
  • std::is_constructible_v<T, std::expected<U, G>>
  • std::is_constructible_v<T, const std::expected<U, G>&>
  • std::is_constructible_v<T, const std::expected<U, G>>
  • std::is_convertible_v<std::expected<U, G>&, T>
  • std::is_convertible_v<std::expected<U, G>, T>
  • std::is_convertible_v<const std::expected<U, G>&, T>
  • std::is_convertible_v<const std::expected<U, G>, T>
• 以下 4 个值都为 false
  • std::unexpected<E>, std::expected<U, G>&, T>
  • std::is_constructible_v<std::unexpected<E>, std::expected<U, G>>
  • std::is_constructible_v<std::unexpected<E>, const std::expected<U, G>&>
  • std::is_constructible_v<std::unexpected<E>, const std::expected<U, G>>

4) 如果 std::is_convertible_v<const U&, T> 或 std::is_convertible_v<const G&, E> 为 false，则此构造函数是 explicit 的。

5) 如果 std::is_convertible_v<U, T> 或 std::is_convertible_v<G, E> 为 false，则此构造函数是 explicit 的。

6) 仅当满足以下所有条件时，此重载才参与重载决议

• std::is_same_v<std::remove_cvref_t<U>, std::in_place_t> 为 false。
• std::is_same_v<std::expected<T, E>, std::remove_cvref_t<U>> 为 false。
• std::is_constructible_v<T, U> 为 true。
• std::remove_cvref_t<U> 不是 std::unexpected 的特化。
• 如果 T 是（可能带有 cv 限定符的）bool，则 std::remove_cvref_t<U> 不是 std::expected 的特化。

7) 此重载仅在 std::is_constructible_v<E, const G&> 为 true 时参与重载决议。

8) 此重载仅在 std::is_constructible_v<E, G> 为 true 时参与重载决议。

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

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

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

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

void 偏特化构造函数

14) 此构造函数被定义为已删除，除非 std::is_copy_constructible_v<E> 为 true。

如果 std::is_trivially_copy_constructible_v<E> 为 true，则此构造函数是平凡的。

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

如果 std::is_trivially_move_constructible_v<E> 为 true，则此构造函数是平凡的。

16,17) 这些重载仅在满足以下所有条件时参与重载决议

• 对于重载 (16)，std::is_constructible_v<E, const G&> 为 true。
• 对于重载 (17)，std::is_constructible_v<E, G> 为 true。
• std::is_void_v<U> 为 true。
• 以下 4 个值都为 false
  • std::unexpected<E>, std::expected<U, G>&, T>
  • std::is_constructible_v<std::unexpected<E>, std::expected<U, G>>
  • std::is_constructible_v<std::unexpected<E>, const std::expected<U, G>&>
  • std::is_constructible_v<std::unexpected<E>, const std::expected<U, G>>

18) 此重载仅在 std::is_constructible_v<E, const G&> 为 true 时参与重载决议。

19) 此重载仅在 std::is_constructible_v<E, G> 为 true 时参与重载决议。

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

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

异常

主模板构造函数

1) 抛出由 expected 值初始化引发的任何异常。

2) 抛出由 expected 或 unexpected 值初始化引发的任何异常。

3) 抛出由 expected 或 unexpected 值初始化引发的任何异常。

noexcept 规范：  

noexcept(std::is_nothrow_move_constructible_v<T>
    && std::is_nothrow_move_constructible_v<E>)

4,5) 抛出由 expected 或 unexpected 值初始化引发的任何异常。

6) 抛出由 expected 值初始化引发的任何异常。

7,8) 抛出由 unexpected 值初始化引发的任何异常。

9,10) 抛出由 expected 值初始化引发的任何异常。

11,12) 抛出由 unexpected 值初始化引发的任何异常。

void 偏特化构造函数

14-19) 抛出由 unexpected 值初始化引发的任何异常。

21,22) 抛出由 unexpected 值初始化引发的任何异常。

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告	应用于	发布时的行为	正确的行为
LWG 3886	C++23	重载 (6) 的默认模板参数是 T	改为 std::remove_cv_t<T>

另请参见

unexpected (C++23)	表示为意外值 (类模板)
in_placein_place_typein_place_indexin_place_tin_place_type_tin_place_index_t (C++17)	原地构造标签 (标签)
unexpectunexpect_t (C++23)	用于 expected 中非预期值就地构造的标签 (标签)