Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
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 standard library. Public Function

readPositionalAll

Public Function
std.Io.File.readPositionalAll
pub fn readPositionalAll(file: File, io: Io, buffer: []u8, offset: u64) ReadPositionalError!usize

Equivalent to creating a positional reader and reading multiple times to fill buffer.

Returns number of bytes read into buffer. If less than buffer.len, end of file occurred.

See also:

Params

  • file: File
  • io: Io
  • buffer: []u8
  • offset: u64

File

Io/File.zig:573
573
574
575
576
577
578
579
580
581
pub fn readPositionalAll(file: File, io: Io, buffer: []u8, offset: u64) ReadPositionalError!usize {
    var index: usize = 0;
    while (index != buffer.len) {
        const amt = try file.readPositional(io, &.{buffer[index..]}, offset + index);
        if (amt == 0) break;
        index += amt;
    }
    return index;
}