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 › dirStatFilePosix Private Function dirStatFilePosix Doc Source Private Function std.Io.Threaded.dirStatFilePosix
fn dirStatFilePosix (
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/Threaded.zig: 3758
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773 fn dirStatFilePosix (
userdata : ?*anyopaque ,
dir : Dir ,
sub_path : []const u8 ,
options : Dir .StatFileOptions ,
) Dir .StatFileError !File .Stat {
const t : *Threaded = @ptrCast (@alignCast (userdata ));
_ = t ;
var path_buffer : [posix .PATH_MAX ]u8 = undefined ;
const sub_path_posix = try pathToPosix (sub_path , &path_buffer );
const flags : u32 = if (!options .follow_symlinks ) posix .AT .SYMLINK_NOFOLLOW else 0 ;
return posixStatFile (dir .handle , sub_path_posix , flags );
}