std::wstring_convert<Codecvt,Elem,Wide_alloc,Byte_alloc>::converted

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Execution support library (C++26)

Technical specifications

Symbols index

External libraries

 

Localization library

Locales and facets
Locales
has_facet use_facet	locale
Facet category base classes
ctype_base codecvt_base messages_base	time_base money_base
ctype facets
ctype ctype<char> ctype_byname	codecvt codecvt_byname
numeric facets
num_get num_put	numpunct numpunct_byname
collate facets
collate	collate_byname
time facets
time_get time_put	time_get_byname time_put_byname
monetary facets
money_get money_put	moneypunct moneypunct_byname
messages facets
messages	messages_byname

Character classification and conversion
Character classification
isspace isblank (C++11) iscntrl	isupper islower isalpha	ispunct isdigit isxdigit	isalnum isprint isgraph

Character conversions

toupper

tolower

String and stream conversions

wstring_convert (C++11/17/26*)

wbuffer_convert (C++11/17/26*)

Text encoding identifications

text_encoding (C++26)

Unicode conversion facets

codecvt_utf8 (C++11/17/26*)

codecvt_utf16 (C++11/17/26*)

codecvt_utf8_utf16 (C++11/17/26*)

codecvt_mode (C++11/17/26*)

C library locales
LC_ALLLC_COLLATELC_CTYPELC_MONETARYLC_NUMERICLC_TIME	setlocale localeconv lconv

 

std::wstring_convert

Member functions

wstring_convert::wstring_convert

wstring_convert::~wstring_convert

wstring_convert::from_bytes

wstring_convert::to_bytes

wstring_convert::converted

wstring_convert::state

 

Defined in header <locale>
std::size_t converted() const noexcept;

Returns the number of source characters that were successfully processed by the most recent from_bytes() or to_bytes().

Return value

cvtcount

Example

Run this code

#include <codecvt>
#include <iostream>
#include <locale>
#include <string>
 
int main()
{
    std::string utf8 = "z\u00df\u6c34\U0001d10b"; // or u8"zß水𝄋"
                   // or "\x7a\xc3\x9f\xe6\xb0\xb4\xf0\x9d\x84\x8b";
    std::cout << "original UTF-8 string size: " << utf8.size() << '\n';
 
    // the UTF-8 - UTF-32 standard conversion facet
    std::wstring_convert<std::codecvt_utf8<char32_t>, char32_t> cvt;
 
    // UTF-8 to UTF-32
    std::u32string utf32 = cvt.from_bytes(utf8);
    std::cout << "UTF-32 string size: " << utf32.size() << '\n';
    std::cout << "converted() == " << cvt.converted() << '\n';
 
    // UTF-32 to UTF-8
    utf8 = cvt.to_bytes(utf32);
    std::cout << "new UTF-8 string size: " << utf8.size() << '\n';
    std::cout << "converted() == " << cvt.converted() << '\n';
}

Output:

original UTF-8 string size: 10
UTF-32 string size: 4
converted() == 10
new UTF-8 string size: 10
converted() == 4

Defect reports

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

DR	Applied to	Behavior as published	Correct behavior
LWG 2174	C++11	wstring_convert::converted was not required to be noexcept	required

See also

to_bytes	converts a wide string into a byte string (public member function)
from_bytes	converts a byte string into a wide string (public member function)