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. Private Function

failingStream

Private Function
std.Io.Reader.failingStream
fn failingStream(r: *Reader, w: *Writer, limit: Limit) StreamError!usize

Params

Errors

ReadFailed

See the Reader implementation for detailed diagnostics.

WriteFailed

See the Writer implementation for detailed diagnostics.

EndOfStream

End of stream indicated from the Reader. This error cannot originate from the Writer.

File

Io/Reader.zig:1802
1802
1803
1804
1805
1806
1807
fn failingStream(r: *Reader, w: *Writer, limit: Limit) StreamError!usize {
    _ = r;
    _ = w;
    _ = limit;
    return error.ReadFailed;
}