# std::wbuffer_convert

> C++ Atlas: `cppatlas.com/w/cpp/locale/wbuffer_convert` | Source: https://en.cppreference.com/w/cpp/locale/wbuffer_convert | Domain: Localization | Standards: C++11, C++17, C++26

std::wbuffer_convert is a wrapper over stream buffer of type std::basic_streambuf<char> which gives it the appearance of std::basic_streambuf<Elem>.

## Official Specification Summary (cppreference)

```cpp
// Defined in header <locale>

template<
    class Codecvt,
    class Elem = wchar_t,
    class Tr = std::char_traits<Elem>
> class wbuffer_convert : public std::basic_streambuf<Elem, Tr> // (since C++11) (deprecated in C++17) (removed in C++26)
```

`std::wbuffer_convert` is a wrapper over stream buffer of type `std::basic_streambuf<char>` which gives it the appearance of `std::basic_streambuf<Elem>`. All I/O performed through `std::wbuffer_convert` undergoes character conversion as defined by the facet `Codecvt`. `std::wbuffer_convert` assumes ownership of the conversion facet, and cannot use a facet managed by a locale.

The standard facets suitable for use with `std::wbuffer_convert` are `std::codecvt_utf8` for UTF-8/UCS-2 and UTF-8/UCS-4 conversions and `std::codecvt_utf8_utf16` for UTF-8/UTF-16 conversions.

This class template makes the implicit character conversion functionality of `std::basic_filebuf` available for any `std::basic_streambuf`.

### Member types

**Type — Definition**

- `state_type`: `Codecvt::state_type`

### Data members

**Member — Description**

- `std::streambuf*` `bufptr`: a pointer to the underlying byte stream buffer (exposition-only member object*)
- `Codecvt*` `cvtptr`: a pointer to the allocated conversion object (exposition-only member object*)
- `state_type` `cvtstate`: the conversion state object (exposition-only member object*)

### Member functions

- (constructor): constructs a new `wbuffer_convert` (public member function)
- `operator=`: the copy assignment operator is deleted (public member function)
- (destructor): destructs the `wbuffer_convert` and its conversion facet (public member function)
- `rdbuf`: returns or replaces the underlying narrow stream buffer (public member function)
- `state`: returns the current conversion state (public member function)

### See also

| Character conversions | locale-defined multibyte (UTF-8, GB18030) | UTF-8 | UTF-16 |
| --- | --- | --- | --- |
| UTF-16 | [`mbrtoc16`](https://en.cppreference.com/w/cpp/string/multibyte/mbrtoc16) / [`c16rtomb`](https://en.cppreference.com/w/cpp/string/multibyte/c16rtomb) (with C11's DR488) | [`codecvt`](https://en.cppreference.com/w/cpp/locale/codecvt)`<char16_t,char,mbstate_t>` [`codecvt_utf8_utf16`](https://en.cppreference.com/w/cpp/locale/codecvt_utf8_utf16)`<char16_t>` [`codecvt_utf8_utf16`](https://en.cppreference.com/w/cpp/locale/codecvt_utf8_utf16)`<char32_t>` [`codecvt_utf8_utf16`](https://en.cppreference.com/w/cpp/locale/codecvt_utf8_utf16)`<wchar_t>` | N/A |
| UCS-2 | [`c16rtomb`](https://en.cppreference.com/w/cpp/string/multibyte/c16rtomb) (without C11's DR488) | [`codecvt_utf8`](https://en.cppreference.com/w/cpp/locale/codecvt_utf8)`<char16_t>` | [`codecvt_utf16`](https://en.cppreference.com/w/cpp/locale/codecvt_utf16)`<char16_t>` |
| UTF-32 | [`mbrtoc32`](https://en.cppreference.com/w/cpp/string/multibyte/mbrtoc32) / [`c32rtomb`](https://en.cppreference.com/w/cpp/string/multibyte/c32rtomb) | [`codecvt`](https://en.cppreference.com/w/cpp/locale/codecvt)`<char32_t,char,mbstate_t>` [`codecvt_utf8`](https://en.cppreference.com/w/cpp/locale/codecvt_utf8)`<char32_t>` | [`codecvt_utf16`](https://en.cppreference.com/w/cpp/locale/codecvt_utf16)`<char32_t>` |
| system `wchar_t`: UTF-32 (non-Windows) UCS-2 (Windows) | [`mbsrtowcs`](https://en.cppreference.com/w/cpp/string/multibyte/mbsrtowcs) / [`wcsrtombs`](https://en.cppreference.com/w/cpp/string/multibyte/wcsrtombs) [`use_facet`](https://en.cppreference.com/w/cpp/locale/use_facet)`<`[`codecvt`](https://en.cppreference.com/w/cpp/locale/codecvt) `<wchar_t,char,mbstate_t>>`([`locale`](https://en.cppreference.com/w/cpp/locale/locale)) | [`codecvt_utf8`](https://en.cppreference.com/w/cpp/locale/codecvt_utf8)`<wchar_t>` | [`codecvt_utf16`](https://en.cppreference.com/w/cpp/locale/codecvt_utf16)`<wchar_t>` |

- [`wstring_convert`](https://en.cppreference.com/w/cpp/locale/wstring_convert) (C++11): performs conversions between a wide string and a byte string (class template)
- [`codecvt_utf8`](https://en.cppreference.com/w/cpp/locale/codecvt_utf8) (C++11): converts between UTF-8 and UCS-2/UCS-4 (class template)
- [`codecvt_utf8_utf16`](https://en.cppreference.com/w/cpp/locale/codecvt_utf8_utf16) (C++11): converts between UTF-8 and UTF-16 (class template)

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