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 › unimplementedSendFile Public Function unimplementedSendFile Doc Source Public Function std.Io.Writer.unimplementedSendFile
pub fn unimplementedSendFile (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: 2425
2425
2426
2427
2428
2429
2430 pub fn unimplementedSendFile (w : *Writer , file_reader : *File .Reader , limit : Limit ) FileError !usize {
_ = w ;
_ = file_reader ;
_ = limit ;
return error .Unimplemented ;
}
For use when the
Writerimplementation can cannot offer a more efficient implementation than a basic read/write loop on the file.