Заголовочный файл стандартной библиотеки <variant> (C++17)
Материал из cppreference.com
Этот заголовок является частью библиотеки общих утилит.
Включает | ||
(C++20) | Поддержка оператора трёхстороннего сравнения | |
Классы | ||
(C++17) | типобезопасное размеченное объединение (шаблон класса) | |
(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, переданного по указателю, по индексу или типу (если он уникален), возвращает null при ошибке (шаблон функции) | |
(C++17)(C++17)(C++17)(C++17)(C++17)(C++17)(C++20) | сравнивает объекты variant как содержащиеся в них значения (шаблон функции) | |
(C++17) | специализация алгоритма std::swap (шаблон функции) |
[править]Краткое описание
#include <compare> namespace std {// шаблонный класс varianttemplate<class... Types>class variant; // вспомогательные классы для varianttemplate<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/* see description */ 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(/* see description */); // класс 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; // swapconstexprvoid swap(variant&)noexcept(/* смотрите описание */);};}
[править]Класс std::monostate
struct monostate{};
[править]Класс std::bad_variant_access
class bad_variant_access :public exception {public:// смотрите [исключение] для спецификации специальных функций-элементовconstchar* what()constnoexcept override;};