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 › dirReadLink Private Function dirReadLink Doc Source Private Function std.Io.Dispatch.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/Dispatch.zig: 3043
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071 fn dirReadLink (
userdata : ?*anyopaque ,
dir : Dir ,
sub_path : []const u8 ,
buffer : []u8 ,
) Dir .ReadLinkError !usize {
const ev : *Evented = @ptrCast (@alignCast (userdata ));
_ = ev ;
var sub_path_buffer : [c .PATH_MAX ]u8 = undefined ;
const sub_path_posix = try pathToPosix (sub_path , &sub_path_buffer );
while (true ) {
const rc = c .readlinkat (dir .handle , sub_path_posix , buffer .ptr , buffer .len );
switch (c .errno (rc )) {
.SUCCESS => return @intCast (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 ),
}
}
}