use-xz 0.1.0

XZ labels and option metadata for RustUse
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

#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

//! XZ labels and option metadata for `RustUse`.

/// Common xz file extension.
pub const XZ_EXTENSION: &str = "xz";
/// Common xz-compressed tar extension.
pub const TAR_XZ_EXTENSION: &str = "tar.xz";
/// Common LZMA label.
pub const LZMA_LABEL: &str = "lzma";
/// Common xz-related extensions.
pub const XZ_EXTENSIONS: &[&str] = &["xz", "lzma", "txz", "tar.xz"];

/// XZ integrity check labels.
#[derive(Clone, Copy, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub enum XzCheckType {
    /// No integrity check.
    None,
    /// CRC32 integrity check.
    Crc32,
    /// CRC64 integrity check.
    #[default]
    Crc64,
    /// SHA-256 integrity check.
    Sha256,
    /// Unknown or intentionally unspecified check type.
    Unknown,
}

impl XzCheckType {
    /// Returns a stable lowercase label.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::None => "none",
            Self::Crc32 => "crc32",
            Self::Crc64 => "crc64",
            Self::Sha256 => "sha256",
            Self::Unknown => "unknown",
        }
    }
}

/// XZ option metadata.
#[derive(Clone, Copy, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct XzOptions {
    /// Numeric xz preset level, when specified by the caller.
    pub level: Option<u32>,
    /// Integrity check type label.
    pub check_type: XzCheckType,
}

impl XzOptions {
    /// Creates default xz option metadata.
    #[must_use]
    pub const fn new() -> Self {
        Self {
            level: None,
            check_type: XzCheckType::Crc64,
        }
    }

    /// Adds a numeric preset level label.
    #[must_use]
    pub const fn with_level(mut self, level: u32) -> Self {
        self.level = Some(level);
        self
    }

    /// Sets the integrity check type label.
    #[must_use]
    pub const fn with_check_type(mut self, check_type: XzCheckType) -> Self {
        self.check_type = check_type;
        self
    }
}

#[cfg(test)]
mod tests {
    use super::{TAR_XZ_EXTENSION, XZ_EXTENSIONS, XzCheckType, XzOptions};

    #[test]
    fn exposes_xz_labels() {
        assert_eq!(TAR_XZ_EXTENSION, "tar.xz");
        assert!(XZ_EXTENSIONS.contains(&"txz"));
    }

    #[test]
    fn stores_option_metadata() {
        let options = XzOptions::new()
            .with_level(6)
            .with_check_type(XzCheckType::Sha256);

        assert_eq!(options.level, Some(6));
        assert_eq!(options.check_type.as_str(), "sha256");
    }
}