std::variant

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

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

语言支持库

概念库(C++20)

诊断库

内存管理库

元编程库(C++11)

通用工具库

容器库

迭代器库

范围库(C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库(C++17)

并发支持库(C++11)

执行控制库(C++26)

技术规范

符号索引

外部库

 

工具库

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

成员函数

variant::variant

variant::~variant

variant::operator=

观察器

variant::index

variant::valueless_by_exception

修改器

variant::emplace

variant::swap

探访

variant::visit (C++26)

非成员函数

visit(std::variant)

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

 

在标头 <variant> 定义
template<class... Types> class variant;		(C++17 起)

类模板 std::variant 表示一个类型安全的联合体（以下称“变体”）。

一个 variant 的实例在任意时刻要么保有它的可选类型之一的值，要么在错误情况下无值（此状态难以达成，见 valueless_by_exception）。

与联合体类似，如果变体保有某个对象类型 T 的值，那么该 T 对象内嵌于variant 对象。

变体不能保有引用、数组，或类型 void。

变体可以保有同一类型多于一次，而且可保有同一类型的不同 cv 限定版本。

与联合体在聚合初始化中的行为一致，默认构造的变体保有它的首个选项的值，除非该选项不可默认构造（此时该变体也不可默认构造）。可以用辅助类 std::monostate 使这种变化体可默认构造。

如果程序在没有提供任何模板实参的情况下实例化了 std::variant 的定义，那么程序非良构。此时可以使用 std::variant<std::monostate> 代替。

如果程序声明了 std::variant 的显式或部分特化，那么程序非良构，不要求诊断。

模板形参

Types

-

可在此变体中存储的类型。所有类型必须都满足可析构(Destructible) 的要求（特别是不允许数组类型和非对象类型）。

成员函数

(构造函数)	构造 variant 对象 (公开成员函数)
(析构函数)	析构 variant 和它包含的值 (公开成员函数)
operator=	赋值 variant (公开成员函数)
观察器
index	返回 variant 所保有可选项的零基索引 (公开成员函数)
valueless_by_exception	检查 variant 是否在非法状态 (公开成员函数)
修改器
emplace	原位构造 variant 中的值 (公开成员函数)
swap	与另一 variant 交换 (公开成员函数)
观览
visit (C++26)	以 variant 所保有的实参调用提供的函数对象 (公开成员函数)

非成员函数

visit (C++17)	以一或多个 variant 所保有的各实参调用所提供的函数对象 (函数模板)
holds_alternative (C++17)	检查某个 variant 是否当前持有某个给定类型 (函数模板)
std::get(std::variant) (C++17)	以给定索引或类型（如果类型唯一）读取 variant 的值，错误时抛出异常 (函数模板)
get_if (C++17)	以给定索引或类型（如果唯一），获得指向被指向的 variant 的值的指针，错误时返回空指针 (函数模板)
operator==operator!=operator<operator<=operator>operator>=operator<=> (C++17)(C++17)(C++17)(C++17)(C++17)(C++17)(C++20)	以所含值比较 variant 对象 (函数模板)
std::swap(std::variant) (C++17)	特化 std::swap 算法 (函数模板)

辅助类

monostate (C++17)	用作非可默认构造类型的 variant 的首个可选项的占位符类型 (类)
bad_variant_access (C++17)	非法地访问 variant 的值时抛出的异常 (类)
variant_sizevariant_size_v (C++17)	在编译时获得 variant 可选项列表的大小 (类模板)(变量模板)
variant_alternativevariant_alternative_t (C++17)	在编译时获得按索引指定的可选项的类型 (类模板)(别名模板)
std::hash<std::variant> (C++17)	std::variant 的散列支持 (类模板特化)

辅助对象

variant_npos (C++17)

非法状态的 variant 的下标 (常量)

提示

功能特性测试宏	值	标准	功能特性
__cpp_lib_variant	201606L	(C++17)	std::variant: 类型安全的联合体
	202102L	(C++23) (DR17)	用于 std::variant 派生类的 std::visit}}
	202106L	(C++23) (DR20)	完全 constexpr 的 std::variant
	202306L	(C++26)	visit 成员

示例

运行此代码

#include <cassert>#include <iostream>#include <string>#include <variant>   int main(){ std::variant<int, float> v, w; v =42;// v 含 intint i =std::get<int>(v);assert(42== i);// 成功 w =std::get<int>(v); w =std::get<0>(v);// 与前一行效果相同 w = v;// 与前一行效果相同   // std::get<double>(v); // 错误：[int, float] 中无 double// std::get<3>(v); // 错误：有效索引值为 0 与 1   try{std::get<float>(w);// w 含 int 而非 float：会抛出异常}catch(conststd::bad_variant_access& ex){std::cout<< ex.what()<<'\n';}   usingnamespace std::literals;   std::variant<std::string> x("abc");// 转换构造函数在无歧义时起作用 x ="def";// 转换赋值在无歧义时亦起作用   std::variant<std::string, voidconst*> y("abc");// 传递 char const* 时转换成 void const*assert(std::holds_alternative<voidconst*>(y));// 成功 y ="xyz"s;assert(std::holds_alternative<std::string>(y));// 成功}

可能的输出：

std::get: wrong index for variant

缺陷报告

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

缺陷报告	应用于	出版时的行为	正确行为
LWG 2901	C++17	提供 std::uses_allocator 的特化，但 variant 不能正确支持分配器	移除该特化
LWG 3990	C++17	程序可以声明 std::variant 的显式或部分特化	此时程序非良构（不要求诊断）
LWG 4141	C++17	对存储分配的要求难以理解	包含的对象必须内嵌于 variant 对象

参阅

in_place in_place_type in_place_index in_place_t in_place_type_t in_place_index_t (C++17)	原位构造标签 (类模板)
optional (C++17)	可能或可能不保有一个对象的包装器 (类模板)
any (C++17)	可保有任何可复制构造(CopyConstructible) 类型的实例的对象。 (类)