std::variant<Types...>::variant

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

工具库

语言支持 类型支持（基本类型、 RTTI 、类型特征）     库功能特性测试宏 (C++20) 动态内存管理 程序工具 错误处理 协程支持 (C++20) 变参数函数 launder (C++17) 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)

通用工具 日期和时间 函数对象 bitset 格式化库 (C++20) hash (C++11) integer_sequence (C++14) 关系运算符 (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) forward (C++11) move (C++11) move_if_noexcept (C++11) as_const (C++17) to_underlying (C++23) 常用词汇类型 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) 初等字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) 栈踪 stacktrace_entry (C++23) basic_stacktrace (C++23)

 

std::variant

成员函数

variant::variant

variant::~variant

variant::operator=

观察器

variant::index

variant::valueless_by_exception

修改器

variant::emplace

variant::swap

非成员函数

visit

holds_alternative

get

get_if

operator==operator!=operator<operator<=operator>operator>=operator<=> (C++20)

swap

辅助类

monostate

bad_variant_access

variant_size

variant_alternative

hash

辅助对象

variant_npos

 

constexpr variant() noexcept(/* see below */);	(1)	(C++17 起)
constexpr variant( const variant& other );	(2)	(C++17 起)
constexpr variant( variant&& other ) noexcept(/* see below */);	(3)	(C++17 起)
template< class T > constexpr variant( T&& t ) noexcept(/* see below */);	(4)	(C++17 起)
template< class T, class... Args > constexpr explicit variant( std::in_place_type_t<T>, Args&&... args );	(5)	(C++17 起)
template< class T, class U, class... Args > constexpr explicit variant( std::in_place_type_t<T>,                             std::initializer_list<U> il, Args&&... args );	(6)	(C++17 起)
template< std::size_t I, class... Args > constexpr explicit variant( std::in_place_index_t<I>, Args&&... args );	(7)	(C++17 起)
template< std::size_t I, class U, class... Args > constexpr explicit variant( std::in_place_index_t<I>,                             std::initializer_list<U> il, Args&&... args );	(8)	(C++17 起)

构造新的 variant 对象。

1) 默认构造函数。构造 variant ，保有首个可选项的值初始化的值（ index() 为零）。

• 当且仅当可选项类型 T_0 的值初始化满足 constexpr 函数的要求，此构造函数才为 constexpr 。
• 此重载仅若 std::is_default_constructible_v<T_0> 为 true 才参与重载决议。

2) 复制构造函数。若 other 非因异常无值，则构造一个保有与 other 相同可选项的 variant ，并以 std::get<other.index()>(other) 直接初始化所含值。否则，初始化一个因异常无值的 variant 。

• 此构造函数定义为被删除，除非 std::is_copy_constructible_v<T_i> 对于所有 Types... 中的 T_i 为 true 。
• 若 std::is_trivially_copy_constructible_v<T_i> 对 Types... 中的所有 T_i 为 true 则它为平凡。

3) 移动构造函数。若 other 非因异常无值，则构造一个保有与 other 相同可选项的 variant 并以 std::get<other.index()>(std::move(other)) 直接初始化所含值。否则，初始化一个因异常无值的 variant。

• 此重载仅若 std::is_move_constructible_v<T_i> 对于所有Types... 中的 T_i 为 true 才参与重载决议。
• 若 std::is_trivially_move_constructible_v<T_i> 对 Types... 中的所有 T_i 为 true 则它为平凡。

4) 转换构造函数。构造保有会被重载决议对表达式 F(std::forward<T>(t)) 选择的可选项 T_j ，假设对来自 Types... 中的每个 T_i 同时存在一个虚构函数 F(T_i) 的重载，除了：

• 仅若声明 T_i x[] = { std::forward<T>(t) }; 对某个虚设变量 x 才考虑 F(T_i) ；
• 若 T_i 是（可有 cv 限定的） bool ，则仅若 std::decay_t<T> (C++20 前)std::remove_cvref_t<T> (C++20 起) 亦为 bool 才考虑 F(T_i) 。

如同用直接非列表初始化从 std::forward<T>(t) 直接初始化所含值。

• 此重载仅若
  • sizeof...(Types) > 0 ，
  • std::decay_t<U> (C++20 前)std::remove_cvref_t<U> (C++20 起) 既不与 variant 为同一类型，亦非 std::in_place_type_t 或 std::in_place_index_t 的特化，
  • std::is_constructible_v<T_j, T> 为 true ，
  • 且表达式 F(std::forward<T>(t)) （令 F 为上述虚构函数的重载集）为良构才参与重载决议。
• 若 T_j 的被选择构造函数为 constexpr 构造函数，则此构造函数为 constexpr 构造函数。

std::variant<std::string> v("abc"); // OK
std::variant<std::string, std::string> w("abc"); // 谬构
std::variant<std::string, const char*> x("abc"); // OK ：选择 const char*
std::variant<std::string, bool> y("abc"); // OK ：选择 string ； bool 不是候选
std::variant<float, long, double> z = 0; // OK ：保有 long
                                         // float 与 double 不是候选

5) 构造一个有指定可选项类型 T 的 variant 并以参数 std::forward<Args>(args)... 初始化所含值。

• 若 T 的被选择构造函数是 constexpr 构造函数，则此构造函数亦为 constexpr 构造函数。
• 此重载仅若 Types... 中正好出现一次 T 且 std::is_constructible_v<T, Args...> 为 true 才参与重载决议。

6) 构造一个有指定可选项类型 T 的 variant 并以参数 il, std::forward<Args>(args)... 初始化所含值。

• 若 T 的被选择构造函数是 constexpr 构造函数，则此构造函数亦为 constexpr 构造函数。
• 此重载仅若 Types... 中正好出现一次 T 且 std::is_constructible_v<T, initializer_list<U>&, Args...> 为 true 才参与重载决议。

7) 构造一个有下标 I 所指定的可选项类型 {{tt|T_i} }的 variant 并以参数std::forward<Args>(args)... 初始化所含值。

• 若 T_i 的被选择构造函数是 constexpr 构造函数，则此构造函数亦为 constexpr 构造函数。
• 此重载仅若 I < sizeof...(Types) 与 std::is_constructible_v<T_i, Args...> 皆为 true 才参与重载决议。

8) 构造一个有下标 I 所指定的可选项类型 T_i 的 variant 并以参数 il, std::forward<Args>(args)... 初始化所含值。

• 若 T_i 的被选择构造函数是 constexpr 构造函数，则此构造函数亦为 constexpr 构造函数。
• 此重载仅若 I < sizeof...(Types) 与 std::is_constructible_v<T_i, std::initializer_list<U>&, Args...> 皆为 true 才参与重载决议。

参数

other	-	另一个要复制/移动其所含值的 variant 对象
t	-	用以初始化被所含值的值
args...	-	用以初始化被所含值的参数
il	-	用以初始化被所含值的初始化器列表
a	-	传递给被所含值的分配器

异常

1) 可能抛出首个可选项的值初始化所抛的任何异常。

noexcept 说明：  

noexcept(std::is_nothrow_default_constructible_v<T_0>)

2) 可能抛出直接初始化任何 Types... 中的 T_i 所抛的任何异常。

3) 可能抛出移动构造任何 Types... 中的 T_i 所抛的任何异常。

noexcept 说明：  

noexcept( (std::is_nothrow_move_constructible_v<Types> && ...))

4) 可能抛出初始化所选可选项T_j所抛的任何异常。

noexcept 说明：  

noexcept(std::is_nothrow_constructible_v<T_j, T>)

5-8) 可能抛出调用所选可选项的所选构造函数所抛的任何异常。

缺陷报告

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

DR	应用于	出版时的行为	正确行为
LWG 2901	C++17	提供具分配器构造函数但 variant 不能正确支持分配器	移除构造函数
P0739R0	C++17	转换构造函数模板与类模板实参推导交互困难	添加了制约
LWG 3024	C++17	若任何成员类型非可复制，则复制构造函数不参与重载决议	改为定义为被删除
P0602R4	C++17	即使底层构造函数平凡，复制/移动构造函数亦可为非平凡	要求传播平凡性
P0608R3	C++17	转换构造函数盲目地组成重载集，导致不想要的转换	不考虑窄化与布尔转换