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 › dirReadLink Private Function dirReadLink Doc Source Private Function std.Io.Uring.dirReadLink
fn dirReadLink (
userdata : ?*anyopaque ,
dir : Dir ,
sub_path : []const u8 ,
buffer : []u8 ,
) Dir .ReadLinkError !usize Params userdata : ?*anyopaque dir : Dir sub_path : []const u8 buffer : []u8 File Io/Uring.zig: 3411
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443 fn dirReadLink (
userdata : ?*anyopaque ,
dir : Dir ,
sub_path : []const u8 ,
buffer : []u8 ,
) Dir .ReadLinkError !usize {
const ev : *Evented = @ptrCast (@alignCast (userdata ));
var sub_path_buffer : [PATH_MAX ]u8 = undefined ;
const sub_path_posix = try pathToPosix (sub_path , &sub_path_buffer );
var sync : CancelRegion .Sync = try .init (ev );
defer sync .deinit (ev );
while (true ) {
try sync .cancel_region .await (.nothing );
const rc = linux .readlinkat (dir .handle , sub_path_posix , buffer .ptr , buffer .len );
switch (linux .errno (rc )) {
.SUCCESS => return @bitCast (rc ),
.INTR => {},
.ACCES => return error .AccessDenied ,
.FAULT => |err | return errnoBug (err ),
.INVAL => return error .NotLink ,
.IO => return error .FileSystem ,
.LOOP => return error .SymLinkLoop ,
.NAMETOOLONG => return error .NameTooLong ,
.NOENT => return error .FileNotFound ,
.NOMEM => return error .SystemResources ,
.NOTDIR => return error .NotDir ,
.ILSEQ => return error .BadPathName ,
else => |err | return unexpectedErrno (err ),
}
}
}