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 standard library.
std › unicode › Utf16LeIterator Public Struct Utf16LeIterator Doc Source Public Struct std.unicode.Utf16LeIterator
pub const Utf16LeIterator = struct Fields bytes : []const u8 i : usize Values Functions File unicode.zig: 491
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523 pub const Utf16LeIterator = struct {
bytes : []const u8 ,
i : usize ,
pub fn init (s : []const u16 ) Utf16LeIterator {
return Utf16LeIterator {
.bytes = mem .sliceAsBytes (s ),
.i = 0 ,
};
}
pub const NextCodepointError = error { DanglingSurrogateHalf , ExpectedSecondSurrogateHalf , UnexpectedSecondSurrogateHalf };
pub fn nextCodepoint (it : *Utf16LeIterator ) NextCodepointError !?u21 {
assert (it .i <= it .bytes .len );
if (it .i == it .bytes .len ) return null ;
var code_units : [2 ]u16 = undefined ;
code_units [0 ] = mem .readInt (u16 , it .bytes [it .i ..][0 ..2 ], .little );
it .i += 2 ;
if (utf16IsHighSurrogate (code_units [0 ])) {
// surrogate pair
if (it .i >= it .bytes .len ) return error .DanglingSurrogateHalf ;
code_units [1 ] = mem .readInt (u16 , it .bytes [it .i ..][0 ..2 ], .little );
const codepoint = try utf16DecodeSurrogatePair (&code_units );
it .i += 2 ;
return codepoint ;
} else if (utf16IsLowSurrogate (code_units [0 ])) {
return error .UnexpectedSecondSurrogateHalf ;
} else {
return code_units [0 ];
}
}
}