std::get(std::variant)

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

工具庫

語言支援 型別支援（基本型別、RTTI） 庫特性測試宏 (C++20) 程式工具 變參函式 initializer_list (C++11) is_constant_evaluated (C++20) is_within_lifetime (C++26) source_location (C++20) 協程支援 (C++20) 契約支援 (C++26) 三路比較 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_ltis_lteq (C++20)(C++20)(C++20)   is_neqis_gtis_gteq (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)

 

std::variant

成員函式

variant::variant

variant::~variant

variant::operator=

觀察器

variant::index

variant::valueless_by_exception

修改器

variant::emplace

variant::swap

訪問（Visitation）

variant::visit (C++26)

非成員函式

visit(std::variant)

holds_alternative

get(std::variant)

get_if

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

swap(std::variant)

輔助類

monostate

bad_variant_access

variant_size

variant_alternative

hash<std::variant>

輔助物件

variant_npos

 

定義於標頭檔案 <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 不是變體中的有效索引，則此呼叫是格式錯誤的。

2) 基於型別的值訪問器：如果 v 包含替代型別 T，則返回對儲存在 v 中的值的引用。否則，丟擲 std::bad_variant_access。如果 T 不是 Types... 的唯一元素，則此呼叫是格式錯誤的。

模板引數

I	-	要查詢的索引
T	-	要查詢的唯一型別
Types...	-	構成 variant 的型別

引數

v

-

一個 variant

返回值

對儲存在變體中的值的引用。

異常

1,2) 錯誤時丟擲 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)	從 std::ranges::subrange 獲取迭代器或哨兵 (函式模板)
get(std::complex) (C++26)	從 std::complex 獲取實部或虛部的引用 (函式模板)