This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig standard library. Public Function
utf16CodepointSequenceLength
Public Function
std.unicode.utf16CodepointSequenceLength
pubfnutf16CodepointSequenceLength(c: u21) !u2
Returns how many code units the UTF-16 representation would require for the given codepoint.
Params
c: u21
File
unicode.zig:449
449450451452453
pubfnutf16CodepointSequenceLength(c: u21) !u2 {
if (c <= 0xFFFF) return1;
if (c <= 0x10FFFF) return2;
returnerror.CodepointTooLarge;
}
Returns how many code units the UTF-16 representation would require for the given codepoint.