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

discardRemaining

Public Function
std.Io.Reader.discardRemaining
pub fn discardRemaining(r: *Reader) ShortError!usize

Consumes the stream until the end, ignoring all the data, returning the number of bytes discarded.

Params

Errors

ReadFailed

See the Reader implementation for detailed diagnostics.

File

Io/Reader.zig:274
274
275
276
277
278
279
280
281
282
283
pub fn discardRemaining(r: *Reader) ShortError!usize {
    var offset: usize = r.end - r.seek;
    r.seek = r.end;
    while (true) {
        offset += r.vtable.discard(r, .unlimited) catch |err| switch (err) {
            error.EndOfStream => return offset,
            else => |e| return e,
        };
    }
}