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.

setRoot

Sets prefix for all other write* method paths. root is assumed to use / for any path separators.

Writer.setRoot

pub fn setRoot(w: *Writer, root: []const u8) Error!void

File

lib/std/tar/Writer.zig:31

Code

pub fn setRoot(w: *Writer, root: []const u8) Error!void {
    if (root.len > 0)
        try w.writeDir(root, .{});

    w.prefix = root;
}