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.

reader

Defaults to positional reading; falls back to streaming.

Positional is more threadsafe, since the global seek position is not affected.

See also:

• readerStreaming

File.reader

pub fn reader(file: File, io: Io, buffer: []u8) Reader

File

lib/std/Io/File.zig:563

Code

pub fn reader(file: File, io: Io, buffer: []u8) Reader {
    return .init(file, io, buffer);
}