std::get_if (std::variant)

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (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_comparable（三路可比较）three_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_eq（是否相等）is_lt（是否小于）is_lteq（是否小于等于） (C++20)(C++20)(C++20)   is_neq（是否不等于）is_gt（是否大于）is_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_equal（比较相等）cmp_less（比较小于）cmp_less_than（比较小于） (C++20)(C++20)(C++20)   cmp_not_equal（比较不相等）cmp_greater（比较大于）cmp_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（变体交换）

访问（Visitation）

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 起)
模板< std::size_t I, 类... Types > constexpr std::add_pointer_t<std::variant_alternative_t<I, std::variant<Types...>>>     get_if( std::variant<Types...>* pv ) noexcept;
模板< std::size_t I, 类... Types > constexpr std::add_pointer_t<const std::variant_alternative_t<I, std::variant<Types...>>>     get_if( const std::variant<Types...>* pv ) noexcept;
			(2)	(C++17 起)
模板< 类 T, 类... Types > constexpr std::add_pointer_t<T>     get_if( std::variant<Types...>* pv ) noexcept;
模板< 类 T, 类... Types > constexpr std::add_pointer_t<const T>     get_if( const std::variant<Types...>* pv ) noexcept;

1) 基于索引的非抛出访问器：如果 pv 不是空指针，且 pv->index() == I，则返回指向 pv 所指向的变体中存储的值的指针。否则，返回空指针值。如果 I 不是变体中的有效索引，则调用是 ill-formed（格式错误）。

2) 基于类型的非抛出访问器：等同于 (1)，其中 I 是 T 在 Types... 中的零基索引。如果 T 不是 Types... 的唯一元素，则调用是 ill-formed（格式错误）。

模板参数

I	-	要查找的索引
类型	-	要查找的唯一类型

参数

pv

-

指向变体的指针

返回值

指向所指向变体中存储的值的指针，或出错时为 null 指针。

示例

运行此代码

#include <iostream>
#include <variant>
 
int main()
{
    auto check_value = [](const std::variant<int, float>& v)
    {
        if (const int* pval = std::get_if<int>(&v))
            std::cout << "variant value: " << *pval << '\n';
        else
            std::cout << "failed to get value!" << '\n';
    };
 
    std::variant<int, float> v{12}, w{3.f};
    check_value(v);
    check_value(w);
}

输出

variant value: 12
failed to get value!

参阅

get(std::variant) (C++17)

根据索引或类型（如果类型唯一）读取变体的值，出错时抛出异常 (函数模板)