# std::swap(std::basic_ofstream)

> C++ Atlas: `cppatlas.com/w/cpp/io/basic_ofstream/swap2` | Source: https://en.cppreference.com/w/cpp/io/basic_ofstream/swap2 | Domain: Input/output | Standards: C++11

Specializes the std::swap algorithm for std::basic_ofstream. Exchanges the state of lhs with that of rhs. Effectively calls lhs.swap(rhs).

## Official Specification Summary (cppreference)

```cpp
template< class CharT, class Traits >
void swap( basic_ofstream<CharT, Traits>& lhs, basic_ofstream<CharT, Traits>& rhs );
```

Specializes the `std::swap` algorithm for `std::basic_ofstream`. Exchanges the state of `lhs` with that of `rhs`. Effectively calls `lhs.swap(rhs)`.

### Parameters

- `lhs, rhs` - streams whose state to swap

### Return value

(none)

### Exceptions

May throw implementation-defined exceptions.

### Example

```cpp
#include <fstream>
#include <iostream>
#include <string>

bool create_stream(std::ofstream& fs)
{
    try
    {
        std::string some_name = "/tmp/test_file.txt";
        std::ios_base::openmode some_flags = fs.trunc; // | other flags

        if (std::ofstream ts{some_name, some_flags}; ts.is_open())
        {
            std::swap(ts, fs); // stream objects are not copyable => swap
            return true;
        }
    }
    catch (...)
    {
        std::cout << "Exception!\n";
    }
    return false;
}

int main()
{
    if (std::ofstream fs; create_stream(fs))
    {
        // use fs stream
    }
}
```

### See also

- [`swap`](https://en.cppreference.com/w/cpp/io/basic_ofstream/swap) (C++11): swaps two file streams (public member function)

---
Attribution: content from https://en.cppreference.com/w/cpp/io/basic_ofstream/swap2 (cppreference.com), licensed under CC-BY-SA 3.0 and GFDL. Modified: converted to markdown, study notes added. Offline snapshot of 9 February 2025.