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.

cwd

Returns a handle to the current working directory.

It is not opened with iteration capability. Iterating over the result is illegal behavior.

Closing the returned Dir is checked illegal behavior.

On POSIX targets, this function is comptime-callable.

This function is overridable via std.Options.cwd.

Dir.cwd

pub fn cwd() Dir

File

lib/std/Io/Dir.zig:88

Code

pub fn cwd() Dir {
    const cwdFn = std.Options.cwd orelse return switch (native_os) {
        .windows => .{ .handle = std.os.windows.peb().ProcessParameters.CurrentDirectory.Handle },
        .wasi => .{ .handle = 3 }, // Expect the first preopen to be current working directory.
        else => .{ .handle = std.posix.AT.FDCWD },
    };
    return cwdFn();
}