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 standard library.
std › Io › Writer › failingSendFile Public Function failingSendFile Doc Source Public Function std.Io.Writer.failingSendFile
pub fn failingSendFile (w : *Writer , file_reader : *File .Reader , limit : Limit ) FileError !usize Params Errors ReadFailed Detailed diagnostics are found on the File.Reader struct.
WriteFailed See the Writer implementation for detailed diagnostics.
EndOfStream Reached the end of the file being read.
Unimplemented Indicates the caller should do its own file reading; the callee cannot offer a more efficient implementation.
File Io/Writer.zig: 2331
2331
2332
2333
2334
2335
2336 pub fn failingSendFile (w : *Writer , file_reader : *File .Reader , limit : Limit ) FileError !usize {
_ = w ;
_ = file_reader ;
_ = limit ;
return error .WriteFailed ;
}