Spec-Zone.ru › C++

std::get(std::variant)

Определён в заголовочном файле <variant>
template< std::size_t I, class... Types >
constexpr std::variant_alternative_t<I, std::variant<Types...>>&
    get( std::variant<Types...>& v );
(1) (начиная с C++17)
template< std::size_t I, class... Types >
constexpr std::variant_alternative_t<I, std::variant<Types...>>&&
    get( std::variant<Types...>&& v );
(2) (начиная с C++17)
template< std::size_t I, class... Types >
constexpr const std::variant_alternative_t<I, std::variant<Types...>>&
    get( const std::variant<Types...>& v );
(3) (начиная с C++17)
template< std::size_t I, class... Types >
constexpr const std::variant_alternative_t<I, std::variant<Types...>>&&
    get( const std::variant<Types...>&& v );
(4) (начиная с C++17)
template< class T, class... Types >
constexpr T& get( std::variant<Types...>& v );
(5) (начиная с C++17)
template< class T, class... Types >
constexpr T&& get( std::variant<Types...>&& v );
(6) (начиная с C++17)
template< class T, class... Types >
constexpr const T& get( const std::variant<Types...>& v );
(7) (начиная с C++17)
template< class T, class... Types >
constexpr const T&& get( const std::variant<Types...>&& v );
(8) (начиная с C++17)
1-4) Доступ к значению по индексу: если v.index() == I, возвращает ссылку на значение, хранящееся в v. В противном случае выбрасывает исключение std::bad_variant_access. Вызов некорректен, если I не является допустимым индексом в variant.
5-8) Доступ к значению по типу: если v содержит альтернативу T, возвращает ссылку на значение, хранящееся в v. В противном случае выбрасывает исключение std::bad_variant_access. Вызов некорректен, если T не является уникальным элементом Types....

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

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

Параметры

v - объект типа variant

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

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

Исключения

При ошибке выбрасывает std::bad_variant_access.

Пример

#include <iostream>
#include <string>
#include <variant>
 
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); // same effect as the previous line
 
//  std::get<double>(v); // error: no double in [int, float]
//  std::get<3>(v);      // error: valid index values are 0 and 1
 
    try
    {
        w = 42.0f;
        std::cout << std::get<float>(w) << '\n'; // ok, prints 42
        w = 42;
        std::cout << std::get<float>(w) << '\n'; // throws
    }
    catch (std::bad_variant_access const& ex)
    {
        std::cout << ex.what() << ": w contained int, not float\n";
    }
}

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

12
42
Unexpected index: w contained int, not float

См. также

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

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

Spec-Zone.ru

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