Struct ArchiveEncoding 

pub struct ArchiveEncoding {
    pub archive: ArchiveFormat,
    pub compression: CompressionFormat,
}

Archive container plus outer compression wrapper.

Fields

archive: ArchiveFormat

Archive container format.

compression: CompressionFormat

Outer compression format, if any.

Implementations

impl ArchiveEncoding

pub const fn new( archive: ArchiveFormat, compression: CompressionFormat, ) -> ArchiveEncoding

Creates an archive encoding from explicit parts.

pub const fn unknown() -> ArchiveEncoding

Returns an unknown archive encoding.

pub fn from_extension(input: &str) -> ArchiveEncoding

Detects an archive encoding from a filename or extension.

Examples found in repository

examples/basic_usage.rs (line 7)

fn main() {
    let encoding = ArchiveEncoding::from_extension("release.tar.zst");

    assert_eq!(encoding.archive, ArchiveFormat::Tar);
    assert_eq!(encoding.compression, CompressionFormat::Zstd);
    assert!(is_safe_relative_archive_path("docs/readme.md"));
    assert!(!is_safe_relative_archive_path("../secrets.env"));

    let policy = ArchivePolicy::strict();
    let manifest = ArchiveManifest::new(encoding).with_entries(vec![
        ArchiveEntry::new("docs/readme.md", ArchiveEntryKind::File).with_size(128),
    ]);

    assert!(policy.allows_entries(manifest.entries()));
    assert_eq!(manifest.file_count(), 1);
    assert_eq!(manifest.total_size(), 128);
}

pub fn from_filename(input: &str) -> ArchiveEncoding

Detects an archive encoding from a filename.

pub const fn has_archive(self) -> bool

Returns whether the archive container is known.

pub const fn is_compressed(self) -> bool

Returns whether an outer compression wrapper is known.

Trait Implementations

impl Clone for ArchiveEncoding

fn clone(&self) -> ArchiveEncoding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArchiveEncoding

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

Formats the value using the given formatter.

impl Default for ArchiveEncoding

fn default() -> ArchiveEncoding

Returns the “default value” for a type.

impl Display for ArchiveEncoding

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

Formats the value using the given formatter.

impl Hash for ArchiveEncoding

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ArchiveEncoding

fn cmp(&self, other: &ArchiveEncoding) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ArchiveEncoding

fn eq(&self, other: &ArchiveEncoding) -> 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 PartialOrd for ArchiveEncoding

fn partial_cmp(&self, other: &ArchiveEncoding) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ArchiveEncoding

impl Eq for ArchiveEncoding

impl StructuralPartialEq for ArchiveEncoding