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 library itself.

readLinkAbsolute

Same as readLink, except it asserts the path is absolute.

On Windows, path should be encoded as WTF-8. On WASI, path should be encoded as valid UTF-8. On other platforms, path is an opaque sequence of bytes with no particular encoding.

Dir.readLinkAbsolute

pub fn readLinkAbsolute(io: Io, absolute_path: []const u8, buffer: []u8) ReadLinkError!usize

File

lib/std/Io/Dir.zig:1311

Code

pub fn readLinkAbsolute(io: Io, absolute_path: []const u8, buffer: []u8) ReadLinkError!usize {
    assert(path.isAbsolute(absolute_path));
    return io.vtable.dirReadLink(io.userdata, .cwd(), absolute_path, buffer);
}