Spec-Zone.ru › C++

Заголовочный файл стандартной библиотеки <variant> (C++17)

Этот заголовочный файл входит в библиотеку общих утилит.

Включаемые заголовочные файлы

<compare>
(C++20)
Поддержка оператора сравнения трехуровневого сравнения Three-way comparison operator

Классы

variant
(C++17)
Безопасный по типам объединенный тип данных
(шаблон класса)
monostate
(C++17)
Тип-заполнитель для использования в качестве первого варианта в объединённом типе данных, для типов, не допускающих неявное создание
(класс)
bad_variant_access
(C++17)
Исключение, выбрасываемое при недопустимом доступе к значению объединённого типа данных
(класс)
variant_sizevariant_size_v
(C++17)
Получение размера списка альтернатив объединённого типа данных во время компиляции
(шаблон класса) (шаблон переменной)
variant_alternativevariant_alternative_t
(C++17)
Получение типа указанной альтернативы по её индексу во время компиляции
(шаблон класса) (шаблон псевдонима)
std::hash<std::variant>
(C++17)
Поддержка хеширования для std::variant
(специализация шаблона класса)

Константы

variant_npos
(C++17)
Индекс недействительного состояния объединённого типа данных
(константа)

Функции

visit
(C++17)
Вызов предоставленного функционального объекта с аргументами, содержащимися в одном или нескольких объединённых типах данных
(шаблон функции)
holds_alternative
(C++17)
Проверка, содержит ли объединённый тип данных заданный тип
(шаблон функции)
get(std::variant)
(C++17)
Чтение значения объединённого типа данных, заданного по индексу или типу (если тип уникален), при ошибке выбрасывает исключение
(шаблон функции)
get_if
(C++17)
Получение указателя на значение указанного объединённого типа данных по индексу или типу (если уникален), при ошибке возвращает null
(шаблон функции)
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 {
  // class template variant
  template<class... Types>
    class variant;
 
  // variant helper classes
  template<class T> struct variant_size;                        // not defined
  template<class T> struct variant_size<const T>;
  template<class T>
    inline constexpr 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;       // not defined
  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;
 
  // value access
  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...>&);
  template<size_t I, class... Types>
    constexpr variant_alternative_t<I, variant<Types...>>&& get(variant<Types...>&&);
  template<size_t I, class... Types>
    constexpr const variant_alternative_t<I, variant<Types...>>&
      get(const variant<Types...>&);
  template<size_t I, class... Types>
    constexpr const 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>
    constexpr const T& get(const variant<Types...>&);
  template<class T, class... Types>
    constexpr const 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;
 
  // relational operators
  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...>&);
 
  // visitation
  template<class Visitor, class... Variants>
    constexpr /* see description */ visit(Visitor&&, Variants&&...);
  template<class R, class Visitor, class... Variants>
    constexpr R visit(Visitor&&, Variants&&...);
 
  // class monostate
  struct monostate;
 
  // monostate relational operators
  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(/* see description */);
 
  // class bad_variant_access
  class bad_variant_access;
 
  // hash support
  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:
    // constructors
    constexpr variant() noexcept(/* see description */);
    constexpr variant(const variant&);
    constexpr variant(variant&&) noexcept(/* see description */);
 
    template<class T>
      constexpr variant(T&&) noexcept(/* see description */);
 
    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&&...);
 
    // destructor
    constexpr ~variant();
 
    // assignment
    constexpr variant& operator=(const variant&);
    constexpr variant& operator=(variant&&) noexcept(/* see description */);
 
    template<class T> constexpr variant& operator=(T&&) noexcept(/* see description */);
 
    // modifiers
    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&&...);
 
    // value status
    constexpr bool valueless_by_exception() const noexcept;
    constexpr size_t index() const noexcept;
 
    // swap
    constexpr void swap(variant&) noexcept(/* see description */);
  };
}

Класс std::monostate

struct monostate{};

Класс std::bad_variant_access

class bad_variant_access : public exception {
public:
  // see [exception] for the specification of the special member functions
  const char* what() const noexcept override;
};

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/header/variant

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API