std::wstring_convert (3) - Linux Man Pages

std::wstring_convert: std::wstring_convert


std::wstring_convert - std::wstring_convert


Defined in header <locale>
template< class Codecvt,
class Elem = wchar_t, (since C++11)
class Wide_alloc = std::allocator<Elem>, (deprecated in C++17)
class Byte_alloc = std::allocator<char> >
class wstring_convert;

Class template std::wstring_convert performs conversions between byte string std::string and wide string std::basic_string<Elem>, using an individual code conversion facet Codecvt. std::wstring_convert assumes ownership of the conversion facet, and cannot use a facet managed by a locale. The standard facets suitable for use with std::wstring_convert are std::codecvt_utf8 for UTF-8/UCS2 and UTF-8/UCS4 conversions and std::codecvt_utf8_utf16 for UTF-8/UTF-16 conversions.

Member types

Member type Definition
byte_string std::basic_string<char, char_traits<char>, Byte_alloc>
wide_string std::basic_string<Elem, char_traits<Elem>, Wide_alloc>
state_type Codecvt::state_type
int_type wide_string::traits_type::int_type

Member functions

              constructs a new wstring_convert
constructor (public member function)
              the copy assignment operator is deleted
operator= (public member function)
              destructs the wstring_convert and its conversion facet
destructor (public member function)
              converts a byte string into a wide string
from_bytes (public member function)
              converts a wide string into a byte string
to_bytes (public member function)
              returns the number of characters successfully converted
converted (public member function)
              returns the current conversion state
state (public member function)

See also

Character locale-defined multibyte UTF-8 UTF-16
conversions (UTF-8, GB18030)
                                                          codecvt<char16_t, char, mbstate_t>
UTF-16 mbrtoc16 / c16rtomb(with C11's DR488) codecvt_utf8_utf16<char16_t> N/A
UCS2 c16rtomb(without C11's DR488) codecvt_utf8<char16_t> codecvt_utf16<char16_t>
                                                          codecvt_utf8<wchar_t>(Windows) codecvt_utf16<wchar_t>(Windows)
                                                          codecvt<char32_t, char, mbstate_t> codecvt_utf16<char32_t>
UTF-32 mbrtoc32 / c32rtomb codecvt_utf8<char32_t> codecvt_utf16<wchar_t>(non-Windows)
system wide: mbsrtowcs / wcsrtombs
UTF-32(non-Windows) use_facet<codecvt No No
UCS2(Windows) <wchar_t, char, mbstate_t>>(locale)

wbuffer_convert performs conversion between a byte stream buffer and a wide stream buffer
                      (class template)
(deprecated in C++17)

codecvt_utf8 converts between UTF-8 and UCS2/UCS4
                      (class template)
(deprecated in C++17)

codecvt_utf8_utf16 converts between UTF-8 and UTF-16
                      (class template)
(deprecated in C++17)