Display the source code in std/utf.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Alias `std.utf.byUTF`

Iterate an input range of characters by char type C by encoding the elements of the range.


						
				alias byUTF(C)
				 = byUTF!(Unqual!C);

UTF sequences that cannot be converted to the specified encoding are replaced by U+FFFD per "5.22 Best Practice for U+FFFD Substitution" of the Unicode Standard 6.2. Hence byUTF is not symmetric. This algorithm is lazy, and does not allocate memory. @nogc, pure-ity, nothrow, and @safe-ty are inferred from the r parameter.

Parameters

Name	Description
C	`char`, `wchar`, or `dchar`

Returns

A forward range if R is a range and not auto-decodable, as defined by isAutodecodableString, and if the base range is also a forward range.

Or, if R is a range and it is auto-decodable and is(ElementEncodingType!typeof(r) == C), then the range is passed to byCodeUnit.

Otherwise, an input range of characters.

Example

import std.algorithm.comparison : equal;

// hellö as a range of `char`s, which are UTF-8
"hell\u00F6".byUTF!char().equal(['h', 'e', 'l', 'l', 0xC3, 0xB6]);

// `wchar`s are able to hold the ö in a single element (UTF-16 code unit)
"hell\u00F6".byUTF!wchar().equal(['h', 'e', 'l', 'l', 'ö']);

// 𐐷 is four code units in UTF-8, two in UTF-16, and one in UTF-32
"𐐷".byUTF!char().equal([0xF0, 0x90, 0x90, 0xB7]);
"𐐷".byUTF!wchar().equal([0xD801, 0xDC37]);
"𐐷".byUTF!dchar().equal([0x00010437]);

Authors

Walter Bright and Jonathan M Davis

License

Boost License 1.0.