Zig 0.17.0-dev (Split by item)

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 library itself.

utf16CodepointSequenceLength

Returns how many code units the UTF-16 representation would require for the given codepoint.

unicode.utf16CodepointSequenceLength
pub fn utf16CodepointSequenceLength(c: u21) !u2

File

lib/std/unicode.zig:440

Code

pub fn utf16CodepointSequenceLength(c: u21) !u2 {
    if (c <= 0xFFFF) return 1;
    if (c <= 0x10FFFF) return 2;
    return error.CodepointTooLarge;
}