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.

length

Retrieve the ending byte index of the file.

Sometimes cheaper than stat if only the length is needed.

File.length

pub fn length(file: File, io: Io) LengthError!u64

File

lib/std/Io/File.zig:286

Code

pub fn length(file: File, io: Io) LengthError!u64 {
    return io.vtable.fileLength(io.userdata, file);
}