std::get(std::variant)

 

C++

编译器支持

独立和宿主式

语言

标准库

标准库头文件

具名要求

特性测试宏 (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::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>
	(1)	(自 C++17 起)
template< std::size_t I, class... Types > constexpr std::variant_alternative_t<I, std::variant<Types...>>&     get( std::variant<Types...>& v );
template< std::size_t I, class... Types > constexpr std::variant_alternative_t<I, std::variant<Types...>>&&     get( std::variant<Types...>&& v );
template< std::size_t I, class... Types > constexpr const std::variant_alternative_t<I, std::variant<Types...>>&     get( const std::variant<Types...>& v );
template< std::size_t I, class... Types > constexpr const std::variant_alternative_t<I, std::variant<Types...>>&&     get( const std::variant<Types...>&& v );
			(2)	(自 C++17 起)
template< class T, class... Types > constexpr T& get( std::variant<Types...>& v );
template< class T, class... Types > constexpr T&& get( std::variant<Types...>&& v );
template< class T, class... Types > constexpr const T& get( const std::variant<Types...>& v );
template< class T, class... Types > constexpr const T&& get( const std::variant<Types...>&& v );

1) 基于索引的值访问器：如果 v.index() == I，则返回对 v 中存储的值的引用。否则，抛出 std::bad_variant_access 异常。如果 I 不是 variant 中的有效索引，则调用是病式的。

2) 基于类型的值访问器：如果 v 保持了类型 T 的候选项，则返回对 v 中存储的值的引用。否则，抛出 std::bad_variant_access 异常。如果 T 不是 Types... 的唯一元素，则调用是病式的。

模板参数

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

参数

v

-

一个 variant

返回值

指向 variant 中存储的值的引用。

异常

1,2) 发生错误时抛出 std::bad_variant_access 。

示例

运行此代码

#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); // same effect as the previous line
 
//  std::get<double>(v); // error: no double in [int, float]
//  std::get<3>(v);      // error: valid index values are 0 and 1
 
    try
    {
        w = 42.0f;
        std::cout << std::get<float>(w) << '\n'; // ok, prints 42
        w = 42;
        std::cout << std::get<float>(w) << '\n'; // throws
    }
    catch (std::bad_variant_access const& ex)
    {
        std::cout << ex.what() << ": w contained int, not float\n";
    }
}

可能的输出

12
42
Unexpected index: w contained int, not float

参见

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