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.

streamRemaining

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

Returns total number of bytes written to w.

Reader.streamRemaining

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

File

lib/std/Io/Reader.zig:262

Code

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,
        };
    }
}