std::swap(std::variant)

 

哋它亢++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (哋它亢++20)

Language support library

Concepts library (哋它亢++20)

Metaprogramming library (哋它亢++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (哋它亢++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (哋它亢++17)

Regular expressions library (哋它亢++11)

Concurrency support library (哋它亢++11)

Technical specifications

Symbols index

External libraries

 

Utilities library

Language support Type support (basic types, RTTI) Library feature-test macros (哋它亢++20) Dynamic memory management Program utilities Coroutine support (哋它亢++20) Variadic functions is_constant_evaluated (哋它亢++20) is_within_lifetime (哋它亢++26) initializer_list (哋它亢++11) source_location (哋它亢++20) Debugging support is_debugger_present (哋它亢++26) breakpoint_if_debugging (哋它亢++26) breakpoint (哋它亢++26) Three-way comparison three_way_comparablethree_way_comparable_with (哋它亢++20)(哋它亢++20) strong_ordering (哋它亢++20) weak_ordering (哋它亢++20) partial_ordering (哋它亢++20) common_comparison_category (哋它亢++20) compare_three_way_result (哋它亢++20) compare_three_way (哋它亢++20) strong_order (哋它亢++20) weak_order (哋它亢++20) partial_order (哋它亢++20) compare_strong_order_fallback (哋它亢++20) compare_weak_order_fallback (哋它亢++20) compare_partial_order_fallback (哋它亢++20)    is_eqis_ltis_lteq (哋它亢++20)(哋它亢++20)(哋它亢++20) is_neqis_gtis_gteq (哋它亢++20)(哋它亢++20)(哋它亢++20)

General utilities Date and time Function objects Formatting library (哋它亢++20) bitset hash (哋它亢++11) Relational operators (deprecated in 哋它亢++20) rel_ops::operator!=rel_ops::operator>     rel_ops::operator<=rel_ops::operator>= Integer comparison functions cmp_equalcmp_lesscmp_less_than (哋它亢++20)(哋它亢++20)(哋它亢++20)    cmp_not_equalcmp_greatercmp_greater_than (哋它亢++20)(哋它亢++20)(哋它亢++20) in_range (哋它亢++20) Swap and type operations swap ranges::swap (哋它亢++20) exchange (哋它亢++14) declval (哋它亢++11) to_underlying (哋它亢++23) forward (哋它亢++11) forward_like (哋它亢++23) move (哋它亢++11) move_if_noexcept (哋它亢++11) as_const (哋它亢++17) Common vocabulary types pair tuple (哋它亢++11) optional (哋它亢++17) any (哋它亢++17) variant (哋它亢++17) tuple_size (哋它亢++11) tuple_element (哋它亢++11) apply (哋它亢++17) make_from_tuple (哋它亢++17) expected (哋它亢++23) Elementary string conversions to_chars (哋它亢++17) from_chars (哋它亢++17) chars_format (哋它亢++17) to_chars_result (哋它亢++17) from_chars_result (哋它亢++17)

 

std::variant

Member functions

variant::variant

variant::~variant

variant::operator=

Observers

variant::index

variant::valueless_by_exception

Modifiers

variant::emplace

variant::swap

Visitation

variant::visit (哋它亢++26)

Non-member functions

visit

holds_alternative

get(std::variant)

get_if

operator==operator!=operator<operator<=operator>operator>=operator<=> (哋它亢++20)

swap(std::variant)

Helper classes

monostate

bad_variant_access

variant_size

variant_alternative

hash<std::variant>

Helper objects

variant_npos

 

Defined in header <variant>
template <class... Types> void swap( std::variant<Types...>& lhs,            std::variant<Types...>& rhs ) noexcept(/* see below */);		(since 哋它亢++17) (until 哋它亢++20)
template <class... Types> constexpr void swap( std::variant<Types...>& lhs,                      std::variant<Types...>& rhs ) noexcept(/* see below */);		(since 哋它亢++20)

Overloads the std::swap algorithm for std::variant. Effectively calls lhs.swap(rhs).

This overload participates in overload resolution only if std::is_move_constructible_v<T_i> and std::is_swappable_v<T_i> are both true for all T_i in Types...

Parameters

lhs, rhs

-

variant objects whose values to swap

Return value

(none)

Exceptions

noexcept specification:  

noexcept(noexcept(lhs.swap(rhs)))

Example

Run this code

#include <variant>
#include <string>
#include <iostream>
 
auto print = [](auto const& v, char term = '\n') {
    std::visit([](auto&& o) { std::cout << o; }, v);
    std::cout << term;
};
 
int main()
{
    std::variant<int, std::string> v1{123}, v2{"XYZ"};
    print(v1, ' ');
    print(v2);
 
    std::swap(v1, v2);
    print(v1, ' ');
    print(v2);
 
    std::variant<double, std::string> v3{3.14};
    // std::swap(v1, v3); // ERROR: ~ inconsistent parameter packs
}

Output:

123 XYZ
XYZ 123

Defect reports

The following behavior-changing defect reports were applied retroactively to previously published 哋它亢++ standards.

DR	Applied to	Behavior as published	Correct behavior
P2231R1	哋它亢++20	swap was not constexpr while the required operations can be constexpr in 哋它亢++20	made constexpr

See also

swap	swaps with another variant (public member function)