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

writeFileBytes

Public Function
std.tar.Writer.writeFileBytes
pub fn writeFileBytes(
    w: *Writer,
    /// Assumed to use `/` for all path separators.
    sub_path: []const u8,
    content: []const u8,
    options: Options,
) Error!void

Writes file using bytes buffer content for size and file content.

Params

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

    Assumed to use / for all path separators.

  • content: []const u8
  • options: Options

Errors

WriteFailed
OctalOverflow
NameTooLong

File

tar/Writer.zig:95
95
96
97
98
99
100
101
102
103
104
105
pub fn writeFileBytes(
    w: *Writer,
    /// Assumed to use `/` for all path separators.
    sub_path: []const u8,
    content: []const u8,
    options: Options,
) Error!void {
    try w.writeHeader(.regular, sub_path, "", content.len, options);
    try w.underlying_writer.writeAll(content);
    try w.writePadding(content.len);
}