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

writeFileStream

Public Function
std.tar.Writer.writeFileStream
pub fn writeFileStream(
    w: *Writer,
    /// Assumed to use `/` for any path separators.
    sub_path: []const u8,
    size: u64,
    reader: *Io.Reader,
    options: Options,
) WriteFileStreamError!void

Writes file reading file content from reader. Reads exactly size bytes from reader, or returns error.EndOfStream.

Params

  • w: *Writer
  • sub_path: []const u8

    Assumed to use / for any path separators.

  • size: u64
  • reader: *Io.Reader
  • options: Options

File

tar/Writer.zig:81
81
82
83
84
85
86
87
88
89
90
91
92
pub fn writeFileStream(
    w: *Writer,
    /// Assumed to use `/` for any path separators.
    sub_path: []const u8,
    size: u64,
    reader: *Io.Reader,
    options: Options,
) WriteFileStreamError!void {
    try w.writeHeader(.regular, sub_path, "", size, options);
    try reader.streamExact64(w.underlying_writer, size);
    try w.writePadding64(size);
}