rars 0.8.0

High-level Rust API for reading, extracting, writing, and repairing RAR archives.
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

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum ArchiveFamily {
    Rar13,
    Rar15To40,
    Rar50Plus,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum ArchiveVersion {
    Rar13,
    Rar14,
    Rar15,
    Rar20,
    Rar29,
    Rar30,
    Rar40,
    Rar50,
    Rar70,
}

impl ArchiveVersion {
    pub const fn family(self) -> ArchiveFamily {
        match self {
            Self::Rar13 | Self::Rar14 => ArchiveFamily::Rar13,
            Self::Rar15 | Self::Rar20 | Self::Rar29 | Self::Rar30 | Self::Rar40 => {
                ArchiveFamily::Rar15To40
            }
            Self::Rar50 | Self::Rar70 => ArchiveFamily::Rar50Plus,
        }
    }

    pub const fn is_rar13_family(self) -> bool {
        matches!(self, Self::Rar13 | Self::Rar14)
    }

    /// Every version, so a caller can ask what each one supports without
    /// keeping its own list that drifts.
    pub const ALL: [Self; 9] = [
        Self::Rar13,
        Self::Rar14,
        Self::Rar15,
        Self::Rar20,
        Self::Rar29,
        Self::Rar30,
        Self::Rar40,
        Self::Rar50,
        Self::Rar70,
    ];

    /// The inverse of [`as_str`](Self::as_str), for callers that take a format
    /// name from outside the process. Separators and case are ignored, and the
    /// short spellings `rar4`, `rar5` and `rar7` name the newest version in
    /// their family, so `rar-5.0` and `RAR5` both reach [`Self::Rar50`].
    pub fn from_name(name: &str) -> Option<Self> {
        match name
            .to_ascii_lowercase()
            .replace(['_', '-', '.', ' '], "")
            .as_str()
        {
            "rar13" => Some(Self::Rar13),
            "rar14" => Some(Self::Rar14),
            "rar15" => Some(Self::Rar15),
            "rar20" => Some(Self::Rar20),
            "rar29" => Some(Self::Rar29),
            "rar30" => Some(Self::Rar30),
            "rar40" | "rar4" => Some(Self::Rar40),
            "rar50" | "rar5" => Some(Self::Rar50),
            "rar70" | "rar7" => Some(Self::Rar70),
            _ => None,
        }
    }

    /// The spelling used by the `--format` argument, and by every message a
    /// user reads. It is the only spelling they can type back into the tool.
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Rar13 => "rar13",
            Self::Rar14 => "rar14",
            Self::Rar15 => "rar15",
            Self::Rar20 => "rar20",
            Self::Rar29 => "rar29",
            Self::Rar30 => "rar30",
            Self::Rar40 => "rar40",
            Self::Rar50 => "rar50",
            Self::Rar70 => "rar70",
        }
    }
}

impl std::fmt::Display for ArchiveVersion {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn maps_versions_to_archive_families() {
        let cases = [
            (ArchiveVersion::Rar13, ArchiveFamily::Rar13),
            (ArchiveVersion::Rar14, ArchiveFamily::Rar13),
            (ArchiveVersion::Rar15, ArchiveFamily::Rar15To40),
            (ArchiveVersion::Rar20, ArchiveFamily::Rar15To40),
            (ArchiveVersion::Rar29, ArchiveFamily::Rar15To40),
            (ArchiveVersion::Rar30, ArchiveFamily::Rar15To40),
            (ArchiveVersion::Rar40, ArchiveFamily::Rar15To40),
            (ArchiveVersion::Rar50, ArchiveFamily::Rar50Plus),
            (ArchiveVersion::Rar70, ArchiveFamily::Rar50Plus),
        ];

        for (version, family) in cases {
            assert_eq!(version.family(), family);
        }
    }

    #[test]
    fn identifies_rar13_family_versions() {
        let cases = [
            (ArchiveVersion::Rar13, true),
            (ArchiveVersion::Rar14, true),
            (ArchiveVersion::Rar15, false),
            (ArchiveVersion::Rar20, false),
            (ArchiveVersion::Rar29, false),
            (ArchiveVersion::Rar30, false),
            (ArchiveVersion::Rar40, false),
            (ArchiveVersion::Rar50, false),
            (ArchiveVersion::Rar70, false),
        ];

        for (version, expected) in cases {
            assert_eq!(version.is_rar13_family(), expected);
        }
    }
}