std::get (std::variant)

 

C++

Поддержка компилятором

Автономные и размещённые реализации

Язык

Стандартная библиотека

Заголовки стандартной библиотеки

Требования к именованию

Макросы тестирования функциональности (C++20)

Поддержка языка

Библиотека концептов (C++20)

Библиотека метапрограммирования (C++11)

Библиотека диагностики

Библиотека общих утилит

Библиотека строк

Библиотека контейнеров

Библиотека итераторов

Библиотека диапазонов (C++20)

Библиотека алгоритмов

Библиотека численных данных

Библиотека ввода/вывода

Библиотека локализаций

Регулярные выражения (C++11)

Атомарные операции (C++11)

Библиотека поддержки конкуренции (C++11)

Библиотека файловой системы (C++17)

Технические спецификации

Указатель символов

Внешние библиотеки

 

Библиотека утилит

Языковая поддержка Поддержка типов (базовые типы, RTTI) Макросы тестирования функциональности библиотеки (C++20)     Управление динамической памятью Программные утилиты Поддержка сопрограмм (C++20) Вариативные функции is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) Трёхстороннее сравнение (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)     is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

Общие утилиты Дата и время Функциональные объекты Библиотека форматирования (C++20) bitset hash (C++11) Операторы отношения (устарело в C++20) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= Целочисленные функции сравнения cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)     cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) Операции обмена и типа swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) Общие лексические типы pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23) Элементарные преобразования строк to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

std::variant

variant::variant

variant::~variant

variant::operator=

variant::index

variant::valueless_by_exception

variant::emplace

variant::swap

visit

holds_alternative

get

get_if

operator==operator!=operator<operator<=operator>operator>=operator<=> (C++20)

swap

monostate

bad_variant_access

variant_size

variant_alternative

hash

variant_npos

 

<tbody> </tbody> <tbody class="t-dcl-rev t-dcl-rev-num t-dcl-rev-notes t-since-cxx17 "> </tbody><tbody> </tbody> <tbody class="t-dcl-rev t-dcl-rev-num t-dcl-rev-notes t-since-cxx17 "> </tbody><tbody> </tbody>

Определено в заголовочном файле <variant>
	(1)	(начиная с C++17)
template< std::size_t I, class... Types > constexpr std::variant_alternative_t<I, std::variant<Types...>>& get( std::variant<Types...>& v );
template< std::size_t I, class... Types > constexpr std::variant_alternative_t<I, std::variant<Types...>>&& get( std::variant<Types...>&& v );
template< std::size_t I, class... Types > constexpr const std::variant_alternative_t<I, std::variant<Types...>>& get( const std::variant<Types...>& v );
template< std::size_t I, class... Types > constexpr const std::variant_alternative_t<I, std::variant<Types...>>&& get( const std::variant<Types...>&& v );
			(2)	(начиная с C++17)
template< class T, class... Types > constexpr T& get( std::variant<Types...>& v );
template< class T, class... Types > constexpr T&& get( std::variant<Types...>&& v );
template< class T, class... Types > constexpr const T& get( const std::variant<Types...>& v );
template< class T, class... Types > constexpr const T&& get( const std::variant<Types...>&& v );

1) Метод доступа к значению на основе индекса: если v.index() == I, возвращает ссылку на значение, хранящееся в v. Иначе генерирует std::bad_variant_access. Вызов некорректен, если I не является допустимым индексом в variant.

2) Метод доступа к значению на основе типа: если v содержит альтернативу T, возвращает ссылку на значение, хранящееся в v. Иначе генерирует std::bad_variant_access. Вызов некорректен, если T не является уникальным элементом Types....

Параметры шаблона

I	—	индекс для поиска
T	—	уникальный тип для поиска
Types...	—	типы, образующие variant

Параметры

v

—

variant

Возвращаемое значение

Ссылка на значение, хранящееся в варианте.

Исключения

1,2) Генерирует std::bad_variant_access при ошибках.

Пример

Запустить этот код

#include <variant>
#include <string>
#include <iostream>
 
int main()
{
    std::variant<int, float> v{12}, w;
    std::cout << std::get<int>(v) << '\n';
    w = std::get<int>(v);
    w = std::get<0>(v); // тот же эффект, что и в предыдущей строке
 
//  std::get<double>(v); // ошибка: нет double в [int, float]
//  std::get<3>(v);      // ошибка: допустимые значения индекса 0 и 1
 
    try
    {
        w = 42.0f;
        std::cout << std::get<float>(w) << '\n'; // ok, печатает 42
        w = 42;
        std::cout << std::get<float>(w) << '\n'; // генерирует исключение
    }
    catch (std::bad_variant_access const& ex)
    {
        std::cout << ex.what() << ": w содержит int, а не float\n";
    }
}

Возможный вывод:

12
42
Unexpected index: w содержит int, а не float

Смотрите также

get_if (C++17)	получает указатель на значение variant, переданного по указателю, по индексу или типу (если он уникален), возвращает null при ошибке (шаблон функции)
std::get(std::tuple) (C++11)	доступ к определённому элементу кортежа (шаблон функции)
std::get(std::array) (C++11)	предоставляет доступ к элементу array (шаблон функции)
std::get(std::pair) (C++11)	доступ к элементу пары (шаблон функции)
get(std::ranges::subrange) (C++20)	получает итератор или ограничитель из std::ranges::subrange (шаблон функции)