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.

setLength

Truncates or expands the file, populating any new data with zeroes.

The file offset after this call is left unchanged.

This function operates on an open file handle. There is not an equivalent function in Dir which operates on paths because generally, such functionality will introduce Time-Of-Check, Time-Of-Use (TOCTOU) bugs. In the rare case when those semantics are actually needed, it is reasonable to open the file with the truncate flag.

File.setLength

pub fn setLength(file: File, io: Io, new_length: u64) SetLengthError!void

File

lib/std/Io/File.zig:277

Code

pub fn setLength(file: File, io: Io, new_length: u64) SetLengthError!void {
    return io.vtable.fileSetLength(io.userdata, file, new_length);
}