◐ Shell
clean mode source ↗

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

Материал из cppreference.com

Этот заголовок является частью библиотеки общих утилит.

Включает

(C++20)

 Поддержка оператора трёхстороннего сравнения [править]

Классы

(C++17)

 типобезопасное размеченное объединение
(шаблон класса) [править]

(C++17)

 тип-заполнитель для использования в качестве первой альтернативы в конструируемых не по умолчанию типах variant
(класс) [править]
исключение при неправильном доступе к значению variant
(класс) [править]
получает размер списка альтернатив во время компиляции
(шаблон класса) (шаблонная переменная) [править]
получает тип альтернативы, указанный её индексом, во время компиляции
(шаблон класса) (псевдоним шаблона) [править]
поддержка хэширования для std::variant
(специализация шаблона класса) [править]

Константы

индекс variant в недопустимом состоянии
(константа) [править]

Функции

(C++17)

 вызывает предоставленный функтор с аргументами, содержащимися в одном или нескольких variant’ах
(шаблон функции) [править]
проверяет, содержит ли variant в настоящее время заданный тип
(шаблон функции) [править]
читает значение variant по заданному индексу или типу (если тип уникален), генерирует исключение при ошибке
(шаблон функции) [править]

(C++17)

 получает указатель на значение variant, переданного по указателю, по индексу или типу (если он уникален), возвращает null при ошибке
(шаблон функции) [править]

(C++17)(C++17)(C++17)(C++17)(C++17)(C++17)(C++20)

 сравнивает объекты variant как содержащиеся в них значения
(шаблон функции) [править]
специализация алгоритма std::swap
(шаблон функции) [править]

Краткое описание

#include <compare>

namespace std {
  // шаблонный класс variant
  template<class... Types>
    class variant;

  // вспомогательные классы для variant
  template<class T> struct variant_size;                        // не определён
  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;       // не определён
  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...>&);
  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;

  // операторы отношения
  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 /* see description */ visit(Visitor&&, Variants&&...);
  template<class R, class Visitor, class... Variants>
    constexpr R visit(Visitor&&, Variants&&...);

  // класс monostate
  struct monostate;

  // monostate реляционные операторы
  constexpr bool operator==(monostate, monostate) noexcept;
  constexpr strong_ordering operator<=>(monostate, monostate) noexcept;

  // специализированные алгоритмы
  template<class... Types>
    constexpr void swap(variant<Types...>&,
                        variant<Types...>&) noexcept(/* see description */);

  // класс bad_variant_access
  class 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<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;

    // swap
    constexpr void swap(variant&) noexcept(/* смотрите описание */);
  };
}

Класс std::monostate

Класс std::bad_variant_access

class bad_variant_access : public exception {
public:
  // смотрите [исключение] для спецификации специальных функций-элементов
  const char* what() const noexcept override;
};