标准库标头 <variant> (C++17)

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏(C++20)

语言支持库

概念库(C++20)

诊断库

内存管理库

元编程库(C++11)

通用工具库

容器库

迭代器库

范围库(C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库(C++17)

并发支持库(C++11)

执行控制库(C++26)

技术规范

符号索引

外部库

 

标准库头

语言支持 <cfloat> <climits> <compare>(C++20) <contracts>(C++26) <coroutine>(C++20) <csetjmp> <csignal> <cstdarg> <cstddef> <cstdint>(C++11) <cstdlib> <exception> <initializer_list>(C++11)    <limits> <new> <source_location>(C++20) <stdfloat>(C++23) <typeinfo> <version>(C++20) 概念 <concepts>(C++20) 诊断 <cassert> <cerrno> <debugging>(C++26) <stacktrace>(C++23) <stdexcept> <system_error>(C++11) 内存管理 <memory> <memory_resource>(C++17) <scoped_allocator>(C++11) 元编程 <type_traits>(C++11) <ratio>(C++11)

通用工具 <any>(C++17) <bitset> <bit>(C++20) <charconv>(C++17) <expected>(C++23) <format>(C++20) <functional> <optional>(C++17) <stdbit.h>(C++26) <tuple>(C++11) <typeindex>(C++11) <utility> <variant>(C++17) 容器 <array>(C++11) <deque> <flat_map>(C++23) <flat_set>(C++23) <forward_list>(C++11) <hive>(C++26) <inplace_vector>(C++26)    <list> <map> <mdspan>(C++23) <queue> <set> <span>(C++20) <stack> <unordered_map>(C++11) <unordered_set>(C++11) <vector> 迭代器 <iterator> 范围 <generator>(C++23) <ranges>(C++20)

算法 <algorithm> <numeric> 字符串 <cctype> <cstring> <cuchar>(C++11) <cwchar> <cwctype> <string_view>(C++17) <string> 文本处理 <clocale> <codecvt>(C++11/17/26*) <locale> <regex>(C++11) <text_encoding>(C++26)    cpp/header#数值库数值 <cfenv>(C++11) <cmath> <complex> <linalg>(C++26) <numbers>(C++20) <random>(C++11) <simd>(C++26) <stdckdint.h>(C++26) <valarray> 时间 <chrono>(C++11) <ctime> C 兼容性 <ccomplex>(C++11/17/20*) <ciso646>(C++20 前) <cstdalign>(C++11/17/20*) <cstdbool>(C++11/17/20*) <ctgmath>(C++11/17/20*)

输入/输出 <cinttypes>(C++11) <cstdio> <filesystem>(C++17) <fstream> <iomanip> <iosfwd> <iostream> <ios> <istream> <ostream> <print>(C++23) <spanstream>(C++23) <sstream> <streambuf> <strstream>(C++98/26*) <syncstream>(C++20) 并发支持 <atomic>(C++11) <barrier>(C++20) <condition_variable>(C++11) <future>(C++11) <hazard_pointer>(C++26) <latch>(C++20) <mutex>(C++11) <rcu>(C++26) <semaphore>(C++20) <shared_mutex>(C++14) <stdatomic.h>(C++23) <stop_token>(C++20) <thread>(C++11) 执行支持 <execution>(C++17)

 

此头文件是通用工具库的一部分。

包含
<compare> (C++20)	三路比较运算符支持
类
variant (C++17)	类型安全的可辨识联合体 (类模板)
monostate (C++17)	用作非可默认构造类型的 variant 的首个可选项的占位符类型 (类)
bad_variant_access (C++17)	非法地访问 variant 的值时抛出的异常 (类)
variant_sizevariant_size_v (C++17)	在编译时获得 variant 可选项列表的大小 (类模板)(变量模板)
variant_alternativevariant_alternative_t (C++17)	在编译时获得按索引指定的可选项的类型 (类模板)(别名模板)
std::hash<std::variant> (C++17)	std::variant 的散列支持 (类模板特化)
常量
variant_npos (C++17)	非法状态的 variant 的下标 (常量)
函数
visit (C++17)	以一或多个 variant 所保有的各实参调用所提供的函数对象 (函数模板)
holds_alternative (C++17)	检查某个 variant 是否当前持有某个给定类型 (函数模板)
std::get(std::variant) (C++17)	以给定索引或类型（如果类型唯一）读取 variant 的值，错误时抛出异常 (函数模板)
get_if (C++17)	以给定索引或类型（如果唯一），获得指向被指向的 variant 的值的指针，错误时返回空指针 (函数模板)
operator==operator!=operator<operator<=operator>operator>=operator<=> (C++17)(C++17)(C++17)(C++17)(C++17)(C++17)(C++20)	以所含值比较 variant 对象 (函数模板)
std::swap(std::variant) (C++17)	特化 std::swap 算法 (函数模板)

概要

#include <compare>   namespace std {// 类模板 varianttemplate<class... Types>class variant;   // variant helper classestemplate<class T>struct variant_size;// 不定义template<class T>struct variant_size<const T>;template<class T>inlineconstexpr size_t variant_size_v = variant_size<T>::value;   template<class... Types>struct variant_size<variant<Types...>>;   template<size_t I, class T>struct variant_alternative;// 不定义template<size_t I, class T>struct variant_alternative<I, const T>;template<size_t I, class T>using variant_alternative_t =typename variant_alternative<I, T>::type;   template<size_t I, class... Types>struct variant_alternative<I, variant<Types...>>;   inlineconstexpr size_t variant_npos =-1;   // 值访问template<class T, class... Types>constexprbool holds_alternative(const variant<Types...>&)noexcept;   template<size_t I, class... Types>constexpr variant_alternative_t<I, variant<Types...>>& get(variant<Types...>&);template<size_t I, class... Types>constexpr variant_alternative_t<I, variant<Types...>>&& get(variant<Types...>&&);template<size_t I, class... Types>constexprconst variant_alternative_t<I, variant<Types...>>& get(const variant<Types...>&);template<size_t I, class... Types>constexprconst variant_alternative_t<I, variant<Types...>>&& get(const variant<Types...>&&);   template<class T, class... Types>constexpr T& get(variant<Types...>&);template<class T, class... Types>constexpr T&& get(variant<Types...>&&);template<class T, class... Types>constexprconst T& get(const variant<Types...>&);template<class T, class... Types>constexprconst T&& get(const variant<Types...>&&);   template<size_t I, class... Types>constexpr add_pointer_t<variant_alternative_t<I, variant<Types...>>> get_if(variant<Types...>*)noexcept;template<size_t I, class... Types>constexpr add_pointer_t<const variant_alternative_t<I, variant<Types...>>> get_if(const variant<Types...>*)noexcept;   template<class T, class... Types>constexpr add_pointer_t<T> get_if(variant<Types...>*)noexcept;template<class T, class... Types>constexpr add_pointer_t<const T> get_if(const variant<Types...>*)noexcept;   // 关系运算符template<class... Types>constexprbool operator==(const variant<Types...>&, const variant<Types...>&);template<class... Types>constexprbool operator!=(const variant<Types...>&, const variant<Types...>&);template<class... Types>constexprbool operator<(const variant<Types...>&, const variant<Types...>&);template<class... Types>constexprbool operator>(const variant<Types...>&, const variant<Types...>&);template<class... Types>constexprbool operator<=(const variant<Types...>&, const variant<Types...>&);template<class... Types>constexprbool operator>=(const variant<Types...>&, const variant<Types...>&);template<class... Types> requires (three_way_comparable<Types>&& ...)constexpr common_comparison_category_t<compare_three_way_result_t<Types>...> operator<=>(const variant<Types...>&, const variant<Types...>&);   // 观览template<class Visitor, class... Variants>constexpr/* 见描述 */ visit(Visitor&&, Variants&&...);template<class R, class Visitor, class... Variants>constexpr R visit(Visitor&&, Variants&&...);   // 类 monostatestruct monostate;   // monostate 关系运算符constexprbool operator==(monostate, monostate)noexcept;constexpr strong_ordering operator<=>(monostate, monostate)noexcept;   // 特化的算法template<class... Types>constexprvoid swap(variant<Types...>&, variant<Types...>&)noexcept(/* 见描述 */);   // 类 bad_variant_accessclass bad_variant_access;   // 散列支持template<class T>struct hash;template<class... Types>struct hash<variant<Types...>>;template<>struct hash<monostate>;}   // 弃用namespace std {template<class T>struct variant_size<volatile T>;template<class T>struct variant_size<constvolatile T>;   template<size_t I, class T>struct variant_alternative<I, volatile T>;template<size_t I, class T>struct variant_alternative<I, constvolatile T>;}

类模板 std::variant

namespace std {template<class... Types>class variant {public:// 构造函数constexpr variant()noexcept(/* 见描述 */);constexpr variant(const variant&);constexpr variant(variant&&)noexcept(/* 见描述 */);   template<class T>constexpr variant(T&&)noexcept(/* 见描述 */);   template<class T, class... Args>constexprexplicit variant(in_place_type_t<T>, Args&&...);template<class T, class U, class... Args>constexprexplicit variant(in_place_type_t<T>, initializer_list<U>, Args&&...);   template<size_t I, class... Args>constexprexplicit variant(in_place_index_t<I>, Args&&...);template<size_t I, class U, class... Args>constexprexplicit variant(in_place_index_t<I>, initializer_list<U>, Args&&...);   // 析构函数constexpr ~variant();   // 赋值constexpr variant& operator=(const variant&);constexpr variant& operator=(variant&&)noexcept(/* 见描述 */);   template<class T>constexpr variant& operator=(T&&)noexcept(/* 见描述 */);   // 修改器template<class T, class... Args>constexpr T& emplace(Args&&...);template<class T, class U, class... Args>constexpr T& emplace(initializer_list<U>, Args&&...);template<size_t I, class... Args>constexpr variant_alternative_t<I, variant<Types...>>& emplace(Args&&...);template<size_t I, class U, class... Args>constexpr variant_alternative_t<I, variant<Types...>>& emplace(initializer_list<U>, Args&&...);   // 值状态constexprbool valueless_by_exception()constnoexcept;constexpr size_t index()constnoexcept;   // 交换constexprvoid swap(variant&)noexcept(/* 见描述 */);};}

类 std::monostate

struct monostate{};

类 std::bad_variant_access

class bad_variant_access :public exception {public:// 特殊成员函数的规范见 [exception]constchar* what()constnoexcept override;};