std::get(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)     type_order (C++26) 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< std::size_t I, class... Types > constexpr std::variant_alternative_t<I, std::variant<Types...>>& get( std::variant<Types...>& v );	(1)	(C++17 起)
template< std::size_t I, class... Types > constexpr std::variant_alternative_t<I, std::variant<Types...>>&& get( std::variant<Types...>&& v );	(2)	(C++17 起)
template< std::size_t I, class... Types > constexpr const std::variant_alternative_t<I, std::variant<Types...>>& get( const std::variant<Types...>& v );	(3)	(C++17 起)
template< std::size_t I, class... Types > constexpr const std::variant_alternative_t<I, std::variant<Types...>>&& get( const std::variant<Types...>&& v );	(4)	(C++17 起)
template< class T, class... Types > constexpr T& get( std::variant<Types...>& v );	(5)	(C++17 起)
template< class T, class... Types > constexpr T&& get( std::variant<Types...>&& v );	(6)	(C++17 起)
template< class T, class... Types > constexpr const T& get( const std::variant<Types...>& v );	(7)	(C++17 起)
template< class T, class... Types > constexpr const T&& get( const std::variant<Types...>&& v );	(8)	(C++17 起)

1-4) 基于索引的值访问器：若 v.index() == I，则返回对 v 中存储的值的引用。否则抛出 std::bad_variant_access。若 I 不是 variant 的有效索引，则此调用非良构。

5-8) 基于类型的值访问器：若 v 保有可选项 T，则返回对 v 中存储的值的引用。否则抛出 std::bad_variant_access。若 T 不是 Types... 中的独有元素，则此调用非良构。

模板形参

I	-	要查找的索引
T	-	要查找的独有类型
Types...	-	构成 variant 的类型

参数

v

-

一个 variant

返回值

对变体中存储的值的引用。

异常

错误时抛出 std::bad_variant_access。

示例

Run this code

#include <iostream>
#include <string>
#include <variant>
 
int main()
{
    std::variant<int, float> v{12}, w;
    std::cout << std::get<int>(v) << '\n';
    w = std::get<int>(v);
    w = std::get<0>(v); // 效果同前一行
 
//  std::get<double>(v); // 错误：[int, float] 中无 double
//  std::get<3>(v);      // 错误：有效的索引值是 0 和 1
 
    try
    {
        w = 42.0f;
        std::cout << std::get<float>(w) << '\n'; // ok, 打印 42
        w = 42;
        std::cout << std::get<float>(w) << '\n'; // 抛出
    }
    catch (std::bad_variant_access const& ex)
    {
        std::cout << ex.what() << ": w 包含 int, 而非 float\n";
    }
}

可能的输出：

12
42
Unexpected index: w 包含 int, 而非 float

参阅

get_if (C++17)	以给定索引或类型（如果唯一），获得指向被指向的 variant 的值的指针，错误时返回空指针 (函数模板)
std::get(std::tuple) (C++11)	元组式访问指定的元素 (函数模板)
get(std::array) (C++11)	访问 array 的一个元素 (函数模板)
std::get(std::pair) (C++11)	访问 pair 的一个元素 (函数模板)
get(std::ranges::subrange) (C++20)	从 std::ranges::subrange 获得迭代器或哨位 (函数模板)
get(std::complex) (C++26)	从 std::complex 获取到实部或虚部的引用 (函数模板)