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 › Dispatch › dirStatFile Private Function dirStatFile Doc Source Private Function std.Io.Dispatch.dirStatFile
fn dirStatFile (
userdata : ?*anyopaque ,
dir : Dir ,
sub_path : []const u8 ,
options : Dir .StatFileOptions ,
) Dir .StatFileError !File .Stat Params userdata : ?*anyopaque dir : Dir sub_path : []const u8 options : Dir .StatFileOptions File Io/Dispatch.zig: 2396
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429 fn dirStatFile (
userdata : ?*anyopaque ,
dir : Dir ,
sub_path : []const u8 ,
options : Dir .StatFileOptions ,
) Dir .StatFileError !File .Stat {
const ev : *Evented = @ptrCast (@alignCast (userdata ));
_ = ev ;
var path_buffer : [c .PATH_MAX ]u8 = undefined ;
const sub_path_posix = try pathToPosix (sub_path , &path_buffer );
const flags : u32 = if (options .follow_symlinks ) 0 else c .AT .SYMLINK_NOFOLLOW ;
while (true ) {
var stat = std .mem .zeroes (c .Stat );
switch (c .errno (c .fstatat (dir .handle , sub_path_posix , &stat , flags ))) {
.SUCCESS => return statFromPosix (&stat ),
.INTR => {},
.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 unexpectedErrno (err ),
}
}
}