archive-rs 0.0.2

archive file library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

//! Which formats and file endings this library supports, depends on cargo
//! features.

use std::fmt;

/// Supported formats.
#[derive(Clone, Copy, Debug)]
pub enum Format {
    #[cfg(feature = "tar")]
    /// tarball
    Tar,

    #[cfg(all(
        feature = "tar",
        any(feature = "bzip2", feature = "bzip2-rs")
    ))]
    /// bzip2-compressed tarball
    TarBzip2,

    #[cfg(all(feature = "tar", feature = "flate2"))]
    /// gzip-compressed tarball
    TarGzip,

    #[cfg(all(feature = "tar", feature = "lz4"))]
    /// lz4-compressed tarball
    TarLz4,

    #[cfg(all(feature = "tar", feature = "xz2"))]
    /// xz-compressed tarball
    TarXz,

    #[cfg(all(feature = "tar", feature = "zstd"))]
    /// zstd-compressed tarball
    TarZstd,
}

impl Format {
    /// Returns the format name.
    #[must_use]
    pub const fn name(&self) -> &'static str {
        match self {
            #[cfg(feature = "tar")]
            Self::Tar => "Tar",

            #[cfg(all(
                feature = "tar",
                any(feature = "bzip2", feature = "bzip2-rs")
            ))]
            Self::TarBzip2 => "TarBzip2",

            #[cfg(all(feature = "tar", feature = "flate2"))]
            Self::TarGzip => "TarGz",

            #[cfg(all(feature = "tar", feature = "lz4"))]
            Self::TarLz4 => "TarLz4",

            #[cfg(all(feature = "tar", feature = "xz2"))]
            Self::TarXz => "TarXz",

            #[cfg(all(feature = "tar", feature = "zstd"))]
            Self::TarZstd => "TarZstd",
        }
    }

    /// Returns the format description, like *gzip-compressed tarball*.
    #[must_use]
    pub const fn description(&self) -> &'static str {
        match self {
            #[cfg(feature = "tar")]
            Self::Tar => "tarball",

            #[cfg(all(
                feature = "tar",
                any(feature = "bzip2", feature = "bzip2-rs")
            ))]
            Self::TarBzip2 => "bzip2-compressed tarball",

            #[cfg(all(feature = "tar", feature = "flate2"))]
            Self::TarGzip => "gzip-compressed tarball",

            #[cfg(all(feature = "tar", feature = "lz4"))]
            Self::TarLz4 => "lz4-compressed tarball",

            #[cfg(all(feature = "tar", feature = "xz2"))]
            Self::TarXz => "xz-compressed tarball",

            #[cfg(all(feature = "tar", feature = "zstd"))]
            Self::TarZstd => "zstd-compressed tarball",
        }
    }

    /// Returns the supported file endings for format auto-detection.
    #[must_use]
    pub fn file_endings(&self) -> Vec<&'static str> {
        match self {
            #[cfg(feature = "tar")]
            Self::Tar => vec!["*.tar"],

            #[cfg(all(
                feature = "tar",
                any(feature = "bzip2", feature = "bzip2-rs")
            ))]
            Self::TarBzip2 => {
                vec!["*.tar.bz2", "*.tbz", "*.tbz2"]
            }

            #[cfg(all(feature = "tar", feature = "flate2"))]
            Self::TarGzip => vec!["*.tar.gz", "*.tgz"],

            #[cfg(all(feature = "tar", feature = "lz4"))]
            Self::TarLz4 => vec!["*.tar.lz4"],

            #[cfg(all(feature = "tar", feature = "xz2"))]
            Self::TarXz => vec!["*.tar.xz", "*.txz"],

            #[cfg(all(feature = "tar", feature = "zstd"))]
            Self::TarZstd => vec!["*.tar.zst"],
        }
    }

    /// Returns all supported format names.
    #[must_use]
    pub const fn all_names<'a>() -> &'a [Self] {
        &[
            #[cfg(feature = "tar")]
            Self::Tar,
            #[cfg(all(
                feature = "tar",
                any(feature = "bzip2", feature = "bzip2-rs")
            ))]
            Self::TarBzip2,
            #[cfg(all(feature = "tar", feature = "flate2"))]
            Self::TarGzip,
            #[cfg(all(feature = "tar", feature = "lz4"))]
            Self::TarLz4,
            #[cfg(all(feature = "tar", feature = "xz2"))]
            Self::TarXz,
            #[cfg(all(feature = "tar", feature = "zstd"))]
            Self::TarZstd,
        ]
    }

    /// Returns all pre-formatted formats in the form of `name description
    /// [endings..]`.
    #[must_use]
    pub fn all_file_endings() -> Vec<String> {
        vec![
            #[cfg(feature = "tar")]
            Self::Tar.describe(),
            #[cfg(all(
                feature = "tar",
                any(feature = "bzip2", feature = "bzip2-rs")
            ))]
            Self::TarBzip2.describe(),
            #[cfg(all(feature = "tar", feature = "flate2"))]
            Self::TarGzip.describe(),
            #[cfg(all(feature = "tar", feature = "lz4"))]
            Self::TarLz4.describe(),
            #[cfg(all(feature = "tar", feature = "xz2"))]
            Self::TarXz.describe(),
            #[cfg(all(feature = "tar", feature = "zstd"))]
            Self::TarZstd.describe(),
        ]
    }

    fn describe(self) -> String {
        format!(
            "{} {} {:?}",
            self.name(),
            self.description(),
            self.file_endings()
        )
    }
}

impl fmt::Display for Format {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.description())
    }
}