Namespaces
Variants
Views
Actions

std::optional<T>::swap

From cppreference.com
< cpp‎ | utility‎ | optional
 
 
Utilities library
General utilities
Date and time
Function objects
Formatting library (C++20)
(C++11)
Relational operators (deprecated in C++20)
Integer comparison functions
(C++20)
Swap and type operations
(C++14)
(C++11)
(C++11)
(C++11)
(C++17)
Common vocabulary types
(C++11)
(C++17)
(C++17)
(C++17)
(C++17)

Elementary string conversions
(C++17)
(C++17)
 
 
void swap( optional& other ) noexcept(/* see below */);
(since C++17)

Swaps the contents with those of other.

  • If neither *this nor other contain a value, the function has no effect.
  • If only one of *this and other contains a value (let's call this object in and the other un), the contained value of un is direct-initialized from std::move(*in), followed by destruction of the contained value of in as if by in->T::~T(). After this call, in does not contain a value; un contains a value.
  • If both *this and other contain values, the contained values are exchanged by calling using std::swap; swap(**this, *other). T lvalues must satisfy Swappable.

The program is ill-formed if std::is_move_constructible_v<T> is false.

Contents

[edit] Parameters

other - the optional object to exchange the contents with

[edit] Return value

(none)

[edit] Exceptions

noexcept specification:  

In the case of thrown exception, the states of the contained values of *this and other are determined by the exception safety guarantees of swap of type T or T's move constructor, whichever is called. For both *this and other, if the object contained a value, it is left containing a value, and the other way round.

[edit] Example

#include <iostream>
#include <string>
#include <optional>
 
int main()
{
    std::optional<std::string> opt1("First example text");
    std::optional<std::string> opt2("2nd text");
 
    auto print_opts = [&](const char* title) {
        std::cout << title << ":\n";
        std::cout << "opt1 contains '" << opt1.value_or("") << "'\n";
        std::cout << "opt2 contains '" << opt2.value_or("") << "'\n";
    };
 
    print_opts("Before swap");
    std::cout << "---SWAP---\n";
    opt1.swap(opt2);
    print_opts("After swap");
    std::cout << '\n';
 
    // Swap with only 1 set
    opt1 = "Lorem ipsum dolor sit amet, consectetur tincidunt.";
    opt2.reset();
 
    print_opts("Before swap");
    std::cout << "---SWAP---\n";
    opt1.swap(opt2);
    print_opts("After swap");
}

Output:

Before swap:
opt1 contains 'First example text'
opt2 contains '2nd text'
---SWAP---
After swap:
opt1 contains '2nd text'
opt2 contains 'First example text'
 
Before swap:
opt1 contains 'Lorem ipsum dolor sit amet, consectetur tincidunt.'
opt2 contains ''
---SWAP---
After swap:
opt1 contains ''
opt2 contains 'Lorem ipsum dolor sit amet, consectetur tincidunt.'

[edit] See also

specializes the std::swap algorithm
(function) [edit]