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

 

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) 调试支持 is_debugger_present (C++26) breakpoint_if_debugging (C++26) breakpoint (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) 初等字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

std::variant

成员函数

variant::variant

variant::~variant

variant::operator=

观察器

variant::index

variant::valueless_by_exception

修改器

variant::emplace

variant::swap

探访

variant::visit (C++26)

非成员函数

visit

holds_alternative

get(std::variant)

get_if

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

swap(std::variant)

辅助类

monostate

bad_variant_access

variant_size

variant_alternative

hash<std::variant>

辅助对象

variant_npos

 

constexpr variant() noexcept(/* 见下文 */);	(1)	(C++17 起)
constexpr variant( const variant& other );	(2)	(C++17 起)
constexpr variant( variant&& other ) noexcept(/* 见下文 */);	(3)	(C++17 起)
template< class T > constexpr variant( T&& t ) noexcept(/* 见下文 */);	(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 并非 valueless_by_exception，则构造一个保有与 other 相同可选项的 variant，并以 *std::get_if<other.index()>(std::addressof(other)) 直接初始化所含值。否则，初始化一个 valueless_by_exception 的变体。

• 此构造函数定义为被弃置，除非 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 并非 valueless_by_exception，则构造一个保有与 other 相同可选项的 variant 并以 std::move(*std::get_if<other.index()>(std::addressof(other))) 直接初始化所含值。否则，初始化一个 valueless_by_exception 的变体。

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

4) 转换构造函数。对 Types... 中的每个 T_i 有一个虚设的函数 F(T_i) 的重载，根据表达式 F(std::forward<T>(t)) 进行重载决议得到 T_j，构造一个持有它的 variant，但不考虑缩小转换。

正式而言：

• 只有当声明 T_i x[] = { std::forward<T>(t) }; 对某个虚设变量 x 有效时，才考虑 F(T_i)。

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

• 此重载只有在
  • sizeof...(Types) > 0，
  • std::decay_t<T> (C++20 前)std::remove_cvref_t<T> (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 所指定的可选项类型 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	-	用以初始化所含值的初始化式列表

异常

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) 可能抛出调用所选可选项的所选构造函数时所抛的任何异常。

示例

运行此代码

#include <cassert>
#include <iostream>
#include <string>
#include <variant>
#include <vector>
 
using vector_t = std::vector<int>;
 
auto& operator<<(auto& out, const vector_t& v)
{
    out << "{ ";
    for (int e : v)
        out << e << ' ';
    return out << '}';
}
 
int main()
{
    // 值初始化第一个可选项
    std::variant<int, std::string> var0;
    assert(std::holds_alternative<int>(var0) and
           var0.index() == 0 and
           std::get<int>(var0) == 0);
 
    // 用 std::string{"STR"}; 初始化第一个可选项
    std::variant<std::string, int> var1{"STR"};
    assert(var1.index() == 0);
    std::cout << "1) " << std::get<std::string>(var1) << '\n';
 
    // 用 int = 42; 初始化第二个可选项
    std::variant<std::string, int> var2{42};
    assert(std::holds_alternative<int>(var2));
    std::cout << "2) " << std::get<int>(var2) << '\n';
 
    // 用 std::string{4, 'A'}; 初始化第一个可选项
    std::variant<std::string, vector_t, float> var3
    {
        std::in_place_type<std::string>, 4, 'A'
    };
    assert(var3.index() == 0);
    std::cout << "3) " << std::get<std::string>(var3) << '\n';
 
    // 用 std::vector{1,2,3,4,5}; 初始化第二个可选项
    std::variant<std::string, vector_t, char> var4
    {
        std::in_place_type<vector_t>, {1, 2, 3, 4, 5}
    };
    assert(var4.index() == 1);
    std::cout << "4) " << std::get<vector_t>(var4) << '\n';
 
    // 用 std::string{"ABCDE", 3}; 初始化第一个可选项
    std::variant<std::string, vector_t, bool> var5 {std::in_place_index<0>, "ABCDE", 3};
    assert(var5.index() == 0);
    std::cout << "5) " << std::get<std::string>(var5) << '\n';
 
    // 用 std::vector(4, 42); 初始化第二个可选项
    std::variant<std::string, vector_t, char> var6 {std::in_place_index<1>, 4, 42};
    assert(std::holds_alternative<vector_t>(var6));
    std::cout << "6) " << std::get<vector_t>(var6) << '\n';
}

输出：

1) STR
2) 42
3) AAAA
4) { 1 2 3 4 5 }
5) ABC
6) { 42 42 42 42 }

缺陷报告

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

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