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.

dirname

Strip the last component from a file path.

If the path is a file in the current directory (no directory component) then returns null.

If the path is the root directory, returns null.

path.dirname

pub fn dirname(path: []const u8) ?[]const u8

File

lib/std/fs/path.zig:1319

Code

pub fn dirname(path: []const u8) ?[]const u8 {
    if (native_os == .windows) {
        return dirnameWindows(path);
    } else {
        return dirnamePosix(path);
    }
}