std::visit

 

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_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

访问（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>
template< class Visitor, class... Variants > constexpr /* 见下方 */ visit( Visitor&& v, Variants&&... values );	(1)	(C++17 起)
template< class R, class Visitor, class... Variants > constexpr R visit( Visitor&& v, Variants&&... values );	(2)	(C++20 起)
帮助模板
template< class... Ts > auto&& as-variant( std::variant<Ts...>& value );	(3)	(仅作说明*)
template< class... Ts > auto&& as-variant( const std::variant<Ts...>& value );	(4)	(仅作说明*)
template< class... Ts > auto&& as-variant( std::variant<Ts...>&& value );	(5)	(仅作说明*)
template< class... Ts > auto&& as-variant( const std::variant<Ts...>&& value );	(6)	(仅作说明*)

将访问器 v （一个可以用来自 Variants 的任意类型组合调用的可调用 (Callable) 对象）应用于 Variants values。

给定 VariantBases 为 decltype(as-variant(std::forward<Variants>(values))...（一个包含 sizeof...(Variants) 个类型的包）。

1) 调用 v，如同通过

INVOKE(std::forward<Visitor>(v),
       std::get<indices>(std::forward<VariantBases>(values))...),

其中 indices 是 as-variant(values).index()...。

2) 调用 v，如同通过

INVOKE<R>(std::forward<Visitor>(v),
          std::get<indices>(std::forward<VariantBases>(values))...),

其中 indices 是 as-variant(values).index()...。

这些重载仅当 VariantBases 中的每个类型都是有效类型时才参与重载决议。如果由 INVOKE 或 INVOKE<R>(C++20 起) 表示的表达式是无效的，或者对于不同的 indices，INVOKE 或 INVOKE<R>(C++20 起) 的结果具有不同的类型或值类别，则程序非良构。

3-6) 仅用于阐释的 as-variant 函数模板接受一个其类型可以被推导为 std::variant<Ts...> 的值（即，要么是 std::variant<Ts...>，要么是从 std::variant<Ts...> 派生的类型），并返回具有相同 const 限定和值类别的 std::variant 值。

3,4) 返回 value。

5,6) 返回 std::move(value)。

参数

v	-	一个可调用 (Callable) 对象，它接受来自 Variants 中每个 variant 的每一种可能的备选类型
values	-	要传递给访问器的 variant 列表

返回值

1) INVOKE 操作的结果。返回类型是通过对结果应用 decltype 获得的类型。

2) 如果 R 是（可能 cv 限定的）void，则无返回值；否则为 INVOKE<R> 操作的结果。

3-6) 从 value 转换而来的 std::variant 值。

异常

如果对于 values 中的任何 variant value_i，as-variant(value_i).valueless_by_exception() 为 true，则抛出 std::bad_variant_access。

复杂度

当 variant 的数量为零或一时，可调用对象的调用以常数时间实现；也就是说，它不依赖于 variant 中可存储的类型数量。

如果 variant 的数量大于一，可调用对象的调用没有复杂度要求。

注意

令 n 为 (1 * ... * std::variant_size_v<std::remove_reference_t<VariantBases>>)，实现通常会为 std::visit 的每个特化生成一个等价于包含 n 个函数指针的（可能多维的）数组的表，这类似于虚函数的实现。

实现也可能为 std::visit 生成一个带有 n 个分支的 switch 语句（例如，当 n 不大于 256 时，MSVC STL 实现使用 switch 语句）。

在典型的实现中，调用 v 的时间复杂度可以被认为等同于访问一个（可能多维的）数组中的元素或执行一个 switch 语句的时间复杂度。

特性测试宏	值	标准	特性
__cpp_lib_variant	202102L	(C++23) (DR17)	支持派生自 std::variant 的类的 std::visit

示例

运行此代码

#include <iomanip>
#include <iostream>
#include <string>
#include <type_traits>
#include <variant>
#include <vector>
 
// the variant to visit
using value_t = std::variant<int, long, double, std::string>;
 
// helper type for the visitor #4
template<class... Ts>
struct overloaded : Ts... { using Ts::operator()...; };
// explicit deduction guide (not needed as of C++20)
template<class... Ts>
overloaded(Ts...) -> overloaded<Ts...>;
 
int main()
{
    std::vector<value_t> vec = {10, 15l, 1.5, "hello"};
 
    for (auto& v: vec)
    {
        // 1. void visitor, only called for side-effects (here, for I/O)
        std::visit([](auto&& arg){ std::cout << arg; }, v);
 
        // 2. value-returning visitor, demonstrates the idiom of returning another variant
        value_t w = std::visit([](auto&& arg) -> value_t { return arg + arg; }, v);
 
        // 3. type-matching visitor: a lambda that handles each type differently
        std::cout << ". After doubling, variant holds ";
        std::visit([](auto&& arg)
        {
            using T = std::decay_t<decltype(arg)>;
            if constexpr (std::is_same_v<T, int>)
                std::cout << "int with value " << arg << '\n';
            else if constexpr (std::is_same_v<T, long>)
                std::cout << "long with value " << arg << '\n';
            else if constexpr (std::is_same_v<T, double>)
                std::cout << "double with value " << arg << '\n';
            else if constexpr (std::is_same_v<T, std::string>)
                std::cout << "std::string with value " << std::quoted(arg) << '\n';
            else
                static_assert(false, "non-exhaustive visitor!");
        }, w);
    }
 
    for (auto& v: vec)
    {
        // 4. another type-matching visitor: a class with 3 overloaded operator()'s
        // Note: The `(auto arg)` template operator() will bind to `int` and `long`
        //       in this case, but in its absence the `(double arg)` operator()
        //       *will also* bind to `int` and `long` because both are implicitly
        //       convertible to double. When using this form, care has to be taken
        //       that implicit conversions are handled correctly.
        std::visit(overloaded{
            [](auto arg) { std::cout << arg << ' '; },
            [](double arg) { std::cout << std::fixed << arg << ' '; },
            [](const std::string& arg) { std::cout << std::quoted(arg) << ' '; }
        }, v);
    }
}

输出

10. After doubling, variant holds int with value 20
15. After doubling, variant holds long with value 30
1.5. After doubling, variant holds double with value 3
hello. After doubling, variant holds std::string with value "hellohello"
10 15 1.500000 "hello"

缺陷报告

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

缺陷报告	应用于	发布时的行为	正确的行为
LWG 2970	C++17	重载 (1) 的返回类型未保留 INVOKE 操作结果的值类别 value category of the result of the INVOKE operation	保留
LWG 3052 (P2162R2)	C++17	若 Variants 中任何类型不是 std::variant，则效果未指定 in Variants is not a std::variant	已指定

参见

visit (C++26)	使用 variant 持有的参数调用提供的函数对象 (公开成员函数)
swap	与另一个 variant 交换 (公开成员函数)