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 › zig › readSourceFileToEndAlloc Public Function readSourceFileToEndAlloc Doc Source Public Function std.zig.readSourceFileToEndAlloc
pub fn readSourceFileToEndAlloc (gpa : Allocator , file_reader : *Io .File .Reader ) ![:0 ]u8 Params File zig.zig: 691
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727 pub fn readSourceFileToEndAlloc (gpa : Allocator , file_reader : *Io .File .Reader ) ![:0 ]u8 {
var buffer : std .ArrayList (u8 ) = .empty ;
defer buffer .deinit (gpa );
if (file_reader .getSize ()) |size | {
const casted_size = std .math .cast (u32 , size ) orelse return error .StreamTooLong ;
// +1 to avoid resizing for the null byte added in toOwnedSliceSentinel below.
try buffer .ensureTotalCapacityPrecise (gpa , casted_size + 1 );
} else |_ | {}
try file_reader .interface .appendRemaining (gpa , &buffer , .limited (max_src_size ));
// Detect unsupported file types with their Byte Order Mark
const unsupported_boms = [_ ][]const u8 {
"\xff\xfe\x00\x00" , // UTF-32 little endian
"\xfe\xff\x00\x00" , // UTF-32 big endian
"\xfe\xff" , // UTF-16 big endian
};
for (unsupported_boms ) |bom | {
if (mem .startsWith (u8 , buffer .items , bom )) {
return error .UnsupportedEncoding ;
}
}
// If the file starts with a UTF-16 little endian BOM, translate it to UTF-8
if (mem .startsWith (u8 , buffer .items , "\xff\xfe" )) {
if (buffer .items .len % 2 != 0 ) return error .InvalidEncoding ;
return std .unicode .utf16LeToUtf8AllocZ (gpa , @ptrCast (@alignCast (buffer .items ))) catch |err | switch (err ) {
error .DanglingSurrogateHalf => error .UnsupportedEncoding ,
error .ExpectedSecondSurrogateHalf => error .UnsupportedEncoding ,
error .UnexpectedSecondSurrogateHalf => error .UnsupportedEncoding ,
else => |e | return e ,
};
}
return buffer .toOwnedSliceSentinel (gpa , 0 );
}
If the source can be UTF-16LE encoded, this function asserts that
gpawill align a byte-sized allocation to at least 2. Allocators that don't do this are rare.