Namespaces
Variants

Standard library header <variant> (C++17)

From cppreference.net
C++
Standard library headers

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

目录

包含文件

(C++20)
三路比较运算符 支持

类

(C++17)
类型安全的可辨识联合体
(类模板)
(C++17)
用作不可默认构造类型的 variant 中首个可选类型的占位符类型
(类)
(C++17)
在无效访问 variant 值时抛出的异常
(类)
(C++17)
在编译时获取 variant 可选项列表的大小
(类模板) (变量模板)
(C++17)
在编译时获取由索引指定的备选类型
(类模板) (别名模板)
(C++17)
对 std::variant 的哈希支持
(类模板特化)

常量

(C++17)
表示 variant 处于无效状态的索引
(常量)

函数

(C++17)
以持有于一个或多个 variant 中的参数调用提供的函数对象
(函数模板)
(C++17)
检查 variant 是否当前持有给定类型
(函数模板)
(C++17)
根据索引或类型（若类型唯一）读取 variant 的值，错误时抛出异常
(函数模板)
(C++17)
获取指向 variant 对象值的指针（根据索引或唯一类型），错误时返回空指针
(函数模板)
(C++17) (C++17) (C++17) (C++17) (C++17) (C++17) (C++20)
比较 variant 对象作为其包含的值
(函数模板)
(C++17)
特化 std::swap 算法
(函数模板)

概要 

// mostly freestanding
#include <compare>
namespace std {
  // class template variant
  template<class... Types> class variant;
  // variant 辅助类
  template<class T> struct variant_size;                  // 未定义
  template<class T> struct variant_size<const T>;
  template<class T> constexpr size_t variant_size_v = variant_size<T>::值;
  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...>>;
  inline constexpr size_t variant_npos = -1;
  // 值访问
  template<class T, class... Types>
  constexpr bool holds_alternative(const variant<Types...>&) noexcept;
  template<size_t I, class... Types>
  constexpr variant_alternative_t<I, variant<Types...>>& get(
    variant<Types...>&);                              // freestanding-deleted
  template<size_t I, class... Types>
  constexpr variant_alternative_t<I, variant<Types...>>&& get(
    variant<Types...>&&);                             // freestanding-deleted
  template<size_t I, class... Types>
  constexpr const variant_alternative_t<I, variant<Types...>>& get(
    const variant<Types...>&);                        // freestanding-deleted
  template<size_t I, class... Types>
  constexpr const variant_alternative_t<I, variant<Types...>>&& get(
    const variant<Types...>&&);                       // freestanding-deleted
  template<class T, class... Types>
  constexpr T& get(variant<Types...>&);               // freestanding-deleted
  template<class T, class... Types>
  constexpr T&& get(variant<Types...>&&);             // freestanding-deleted
  template<class T, class... Types>
  constexpr const T& get(const variant<Types...>&);   // freestanding-deleted
  template<class T, class... Types>
  constexpr const T&& get(const variant<Types...>&&); // freestanding-deleted
  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>
  constexpr bool operator==(const variant<Types...>&, const variant<Types...>&);
  template<class... Types>
  constexpr bool operator!=(const variant<Types...>&, const variant<Types...>&);
  template<class... Types>
  constexpr bool operator<(const variant<Types...>&, const variant<Types...>&);
  template<class... Types>
  constexpr bool operator>(const variant<Types...>&, const variant<Types...>&);
  template<class... Types>
  constexpr bool operator<=(const variant<Types...>&, const variant<Types...>&);
  template<class... Types>
  constexpr bool 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&&...);
  // class monostate
  struct monostate;
  // monostate 关系运算符
  constexpr bool operator==(monostate, monostate) noexcept;
  constexpr strong_ordering operator<=>(monostate, monostate) noexcept;
  // specialized algorithms
  template<class... Types>
  constexpr void swap(variant<Types...>&,
                      variant<Types...>&) noexcept(/* 查看描述 */);
  // class bad_variant_access
  class bad_variant_access;
  // 哈希支持
  template<class T> struct hash;
  template<class... Types> struct hash<variant<Types...>>;
  template<> struct hash<monostate>;
}
// deprecated
namespace std {
  template<class T> struct variant_size<volatile T>;
  template<class T> struct variant_size<const volatile T>;
  template<size_t I, class T> struct variant_alternative<I, volatile T>;
  template<size_t I, class T> struct variant_alternative<I, const volatile 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>
    constexpr explicit variant(in_place_type_t<T>, Args&&...);
    template<class T, class U, class... Args>
    constexpr explicit variant(in_place_type_t<T>, initializer_list<U>, Args&&...);
    template<size_t I, class... Args>
    constexpr explicit variant(in_place_index_t<I>, Args&&...);
    template<size_t I, class U, class... Args>
    constexpr explicit 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&&...);
    // 值状态
    constexpr bool valueless_by_exception() const noexcept;
    constexpr size_t index() const noexcept;
    // 交换
    constexpr void swap(variant&) noexcept(/* 参见描述 */);
    // 访问
    template<class Self, class Visitor>
    constexpr decltype(auto) visit(this Self&&, Visitor&&);
    template<class R, class Self, class Visitor>
    constexpr R visit(this Self&&, Visitor&&);
  };
}

类 std::monostate 

namespace std {
  struct monostate{};
  constexpr bool
  operator==(monostate, monostate) noexcept { return true; }
  constexpr strong_ordering
  operator<=>(monostate, monostate) noexcept
  {
    return strong_ordering::equal;
  }
}

类 std::bad_variant_access 

namespace std {
  class bad_variant_access : public exception
  {
  public:
    // 查看特殊成员函数规范的描述
    constexpr const char* what() const noexcept override;
  };
}