Display the source code in std/encoding.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.

Function `std.encoding.decode`

Decodes a single code point.


						
				dchar decode(S)
				(
				

				  ref S s
				

				);

This function removes one or more code units from the start of a string, and returns the decoded code point which those code units represent.

The input to this function MUST be validly encoded. This is enforced by the function's in-contract.

Supersedes

This function supersedes std.utf.decode(), however, note that the function codePoints() supersedes it more conveniently.

Standards

Unicode 5.0, ASCII, ISO-8859-1, ISO-8859-2, WINDOWS-1250, WINDOWS-1251, WINDOWS-1252

Parameters

Name	Description
s	the string whose first code point is to be decoded

Authors

Janice Caron

License

Boost License 1.0.