Enum Format

pub enum Format {
    InternalTransientNonPersistable,
    Tar,
    TarGz {
        compression_level: Option<u8>,
    },
    Zip {
        compression_level: Option<u8>,
    },
}

The supported container formats for use in write_stream().

Variants

InternalTransientNonPersistable

An internal format that is suitable only for intra-process communication.

All transformations in the options are ignored. Calling write_stream is disallowed as it’s more efficient to call gix_worktree_stream::Stream::into_read() right away. It is provided here as a basis available without extra dependencies, and as a debugging tool.

Tar

A standard tar archive.

Use it as well if a custom container format is desired. The idea is to decode it on a separate thread to rewrite the data to the desired format.

TarGz

A convenience format that will gzip deflate the tar stream.

Fields

compression_level: Option<u8>

If None, use the default compression level. Otherwise use the given one which ranges from 0-9 for the deflate algorithm.

Zip

A standard zip archive. Note that this format silently converts illformed UTF-8 to UTF-8, which will equal a change of path.

Requires the zip feature toggle to have an effect.

Shortcoming

Even though symlinks are stored as such, for some reason at least on MacOS those aren’t restored. That works, however, when letting git create the archive.

Fields

compression_level: Option<u8>

If None, use the default compression level. Otherwise use the given one which ranges from 0-9 for the deflate algorithm.

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Format

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Format

fn default() -> Format

Returns the “default value” for a type.

impl PartialEq for Format

fn eq(&self, other: &Format) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Format

impl Eq for Format

impl StructuralPartialEq for Format