struct PipeOptions [src]

pipeToFileSystem options

Fields

strip_components: u32 = 0Number of directory levels to skip when extracting files.

mode_mode: ModeMode = .executable_bit_onlyHow to handle the "mode" property of files from within the tar file.

exclude_empty_directories: bool = falsePrevents creation of empty directories.

diagnostics: ?*Diagnostics = nullCollects error messages during unpacking

Members

ModeMode (enum)

Source

  pub const PipeOptions = 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,
    };
}  