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

streamRemaining

Doc Source

Public Function

std.Io.Reader.streamRemaining

pub fn streamRemaining(r: *Reader, w: *Writer) StreamRemainingError!usize

"Pump" data from the reader to the writer, handling error.EndOfStream as a success case.

Returns total number of bytes written to w.

Params

r: *Reader
w: *Writer

Errors

ReadFailed: See the Reader implementation for detailed diagnostics.
WriteFailed: See the Writer implementation for detailed diagnostics.

File

Io/Reader.zig:262

pub fn streamRemaining(r: *Reader, w: *Writer) StreamRemainingError!usize {
    var offset: usize = 0;
    while (true) {
        offset += r.stream(w, .unlimited) catch |err| switch (err) {
            error.EndOfStream => return offset,
            else => |e| return e,
        };
    }
}