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 Struct

ExtractOptions

Public Struct
std.tar.ExtractOptions
pub const ExtractOptions = struct

Fields

strip_components: u32 = 0

Number of directory levels to skip when extracting files.

mode_mode: ModeMode = .executable_bit_only

How to handle the "mode" property of files from within the tar file.

exclude_empty_directories: bool = false

Prevents creation of empty directories.

diagnostics: ?*Diagnostics = null

Collects error messages during unpacking

Types

File

tar.zig:126
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
pub const ExtractOptions = struct {
    /// Number of directory levels to skip when extracting files.
    strip_components: u32 = 0,
    /// How to handle the "mode" property of files from within the tar file.
    mode_mode: ModeMode = .executable_bit_only,
    /// Prevents creation of empty directories.
    exclude_empty_directories: bool = false,
    /// Collects error messages during unpacking
    diagnostics: ?*Diagnostics = null,

    pub const ModeMode = enum {
        /// The mode from the tar file is completely ignored. Files are created
        /// with the default mode when creating files.
        ignore,
        /// The mode from the tar file is inspected for the owner executable bit
        /// only. This bit is copied to the group and other executable bits.
        /// Other bits of the mode are left as the default when creating files.
        executable_bit_only,
    };
}