std::visit

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名要求

功能测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用程序库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

执行支持库 (C++26)

技术规范

符号索引

外部库

 

实用程序库

语言支持 类型支持 (基本类型, RTTI) 库功能测试宏 (C++20) 动态内存管理 程序实用程序 协程支持 (C++20) 可变参数函数 is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) 调试支持 is_debugger_present (C++26) breakpoint_if_debugging (C++26) breakpoint (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) 基本字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

std::variant

成员函数

variant::variant

variant::~variant

variant::operator=

观察者

variant::index

variant::valueless_by_exception

修改器

variant::emplace

variant::swap

访问

variant::visit (C++26)

非成员函数

visit

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 /* see below */ visit( Visitor&& vis, Variants&&... vars );	(1)	(自 C++17 起)
template< class R, class Visitor, class... Variants > constexpr R visit( Visitor&& vis, Variants&&... vars );	(2)	(自 C++20 起)
template< class... Ts > auto&& as-variant( std::variant<Ts...>& var );	(3)	(仅供说明* )
template< class... Ts > auto&& as-variant( const std::variant<Ts...>& var );	(4)	(仅供说明* )
template< class... Ts > auto&& as-variant( std::variant<Ts...>&& var );	(5)	(仅供说明* )
template< class... Ts > auto&& as-variant( const std::variant<Ts...>&& var );	(6)	(仅供说明* )

将访问者 vis (一个可以接受来自变体的任意类型组合的可调用对象) 应用于变体 vars.

假设 VariantBases 为 decltype(as-variant(std::forward<Variants>(vars))... (一个包含 sizeof...(Variants) 个类型的包)

1) 调用 vis ，如同调用以下代码：

INVOKE(std::forward<Visitor>(vis),
       std::get<indices>(std::forward<VariantBases>(vars))...),

其中 indices 是 as-variant(vars).index()....

2) 调用 vis ，如同调用以下代码：

INVOKE<R>(std::forward<Visitor>(vis),
          std::get<indices>(std::forward<VariantBases>(vars))...),

其中 indices 是 as-variant(vars).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) 返回 var.

5,6) 返回 std::move(var).

参数

vis	-	一个接受来自每个变体的每个可能备选的可调用对象
vars	-	要传递给访问者的变体列表

返回值

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

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

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

异常

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

复杂度

当变体的数量为零或一时，可调用对象的调用在常数时间内实现，即它不依赖于变体中可以存储的类型的数量。

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

注释

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

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

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

特性测试 宏	值	Std	特性
__cpp_lib_variant	202102L	(C++17) (DR)	std::visit 用于从 std::variant 派生的类

示例

运行此代码

#include <iomanip>
#include <iostream>
#include <string>
#include <type_traits>
#include <variant>
#include <vector>
 
// the variant to visit
using var_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<var_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
        var_t w = std::visit([](auto&& arg) -> var_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++ 标准。

DR	应用于	发布的行为	正确的行为
LWG 2970	C++17	重载 (1) 的返回类型没有保留 INVOKE 操作结果的值类别	保留
LWG 3052 (P2162R2)	C++17	如果 Variants 中的任何类型 不是 std::variant，则效果未指定	指定

另请参阅

swap	与另一个 variant 交换 (公有成员函数)