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 › Io › Threaded › posixStatFile Private Function posixStatFile Doc Source Private Function std.Io.Threaded.posixStatFile
fn posixStatFile (dir_fd : posix .fd_t , sub_path : [:0 ]const u8 , flags : u32 ) Dir .StatFileError !File .Stat Params dir_fd : posix .fd_t sub_path : [:0 ]const u8 flags : u32 File Io/Threaded.zig: 3775
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807 fn posixStatFile (dir_fd : posix .fd_t , sub_path : [:0 ]const u8 , flags : u32 ) Dir .StatFileError !File .Stat {
const syscall : Syscall = try .start ();
while (true ) {
var stat = std .mem .zeroes (posix .Stat );
switch (posix .errno (fstatat_sym (dir_fd , sub_path , &stat , flags ))) {
.SUCCESS => {
syscall .finish ();
return statFromPosix (&stat );
},
.INTR => {
try syscall .checkCancel ();
continue ;
},
else => |e | {
syscall .finish ();
switch (e ) {
.INVAL => |err | return errnoBug (err ),
.BADF => |err | return errnoBug (err ), // File descriptor used after closed.
.NOMEM => return error .SystemResources ,
.ACCES => return error .AccessDenied ,
.PERM => return error .PermissionDenied ,
.FAULT => |err | return errnoBug (err ),
.NAMETOOLONG => return error .NameTooLong ,
.LOOP => return error .SymLinkLoop ,
.NOENT => return error .FileNotFound ,
.NOTDIR => return error .FileNotFound ,
.ILSEQ => return error .BadPathName ,
else => |err | return posix .unexpectedErrno (err ),
}
},
}
}
}