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 › Uring › dirAccess Private Function dirAccess Doc Source Private Function std.Io.Uring.dirAccess
fn dirAccess (
userdata : ?*anyopaque ,
dir : Dir ,
sub_path : []const u8 ,
options : Dir .AccessOptions ,
) Dir .AccessError !void Params userdata : ?*anyopaque dir : Dir sub_path : []const u8 options : Dir .AccessOptions File Io/Uring.zig: 2788
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828 fn dirAccess (
userdata : ?*anyopaque ,
dir : Dir ,
sub_path : []const u8 ,
options : Dir .AccessOptions ,
) Dir .AccessError !void {
const ev : *Evented = @ptrCast (@alignCast (userdata ));
var path_buffer : [PATH_MAX ]u8 = undefined ;
const sub_path_posix = try pathToPosix (sub_path , &path_buffer );
const mode : u32 =
@as (u32 , if (options .read ) linux .R_OK else 0 ) |
@as (u32 , if (options .write ) linux .W_OK else 0 ) |
@as (u32 , if (options .execute ) linux .X_OK else 0 );
const flags : u32 = if (options .follow_symlinks ) 0 else linux .AT .SYMLINK_NOFOLLOW ;
var sync : CancelRegion .Sync = try .init (ev );
defer sync .deinit (ev );
while (true ) {
try sync .cancel_region .await (.nothing );
switch (linux .errno (linux .faccessat (dir .handle , sub_path_posix , mode , flags ))) {
.SUCCESS => return ,
.INTR => {},
.ACCES => return error .AccessDenied ,
.PERM => return error .PermissionDenied ,
.ROFS => return error .ReadOnlyFileSystem ,
.LOOP => return error .SymLinkLoop ,
.TXTBSY => return error .FileBusy ,
.NOTDIR => return error .FileNotFound ,
.NOENT => return error .FileNotFound ,
.NAMETOOLONG => return error .NameTooLong ,
.INVAL => |err | return errnoBug (err ),
.FAULT => |err | return errnoBug (err ),
.IO => return error .InputOutput ,
.NOMEM => return error .SystemResources ,
.ILSEQ => return error .BadPathName ,
else => |err | return unexpectedErrno (err ),
}
}
}