decodeFront
fn
dchar decodeFront(UseReplacementDchar useReplacementDchar = No.useReplacementDchar, S)(
ref S str, out size_t numCodeUnits) if (!isSomeString!S && isInputRange!S && isSomeChar!(ElementType!S))decodeFront is a variant of decode which specifically decodes the first code point. Unlike decode, decodeFront accepts any
of code units (rather than just a string or random access range). It also takes the range by ref and pops off the elements as it decodes them. If numCodeUnits is passed in, it gets set to the number of code units which were in the code point which was decoded.
Parameters
useReplacementDchar | if invalid UTF, return replacementDchar rather than throwing |
str | input string or indexable Range |
numCodeUnits | set to number of code units processed |
Returns
decoded character
Throws
UTFException if
str.front is not the start of a valid UTF
sequence. If an exception is thrown, then there is no guarantee as to the number of code units which were popped off, as it depends on the type of range being used and how many code units had to be popped off before the code point was determined to be invalid.
fn
dchar decodeFront(UseReplacementDchar useReplacementDchar = No.useReplacementDchar, S)(
ref scope S str, out size_t numCodeUnits) if (isSomeString!S) @trusted pureditto
fn
dchar decodeFront(UseReplacementDchar useReplacementDchar = No.useReplacementDchar, S)(ref S str) if (isInputRange!S && isSomeChar!(ElementType!S))Ditto