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.getBOM`

Returns a BOMSeq for a given input. If no BOM is present the BOMSeq for BOM.none is returned. The BOM sequence at the beginning of the range will not be comsumed from the passed range. If you pass a reference type range make sure that save creates a deep copy.


						
				immutable(BOMSeq) getBOM(Range)
				(
				

				  Range input
				

				)
				

				if (isForwardRange!Range && is(Unqual!(ElementType!Range) == ubyte));

Parameters

Name	Description
input	The sequence to check for the `BOM`

Returns

the found BOMSeq corresponding to the passed input.

Example

import std.format : format;

auto ts = dchar(0x0000FEFF) ~ "Hello World"d;

auto entry = getBOM(cast(ubyte[]) ts);
version (BigEndian)
{
    writeln(entry.schema); // BOM.utf32be
}
else
{
    writeln(entry.schema); // BOM.utf32le
}

Authors

Janice Caron

License

Boost License 1.0.