delharc 0.8.0

A library for parsing and extracting files from LHA/LZH 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

//! MS-DOS specific data types
use core::fmt;
use bitflags::bitflags;

bitflags! {
    #[derive(Default, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Clone, Copy)]
    /// MS-DOS attributes
    pub struct MsDosAttrs: u16 {
        /// The file has a READ-ONLY attribute set
        const READ_ONLY = 0b00000000_00000001;
        /// The file has a HIDDEN attribute set
        const HIDDEN    = 0b00000000_00000010;
        /// The file has a SYSTEM attribute set
        const SYSTEM    = 0b00000000_00000100;
        /// The file has a VOLUME attribute set
        const VOLUME    = 0b00000000_00001000;
        /// The file is a directory
        const SUBDIR    = 0b00000000_00010000;
        /// The file has an ARCHIVE attribute set
        const ARCHIVE   = 0b00000000_00100000;
        /// The file is a symbolic link.
        ///
        /// This is not MS-DOS standard attribute, but apparently LHA for
        /// X680x0 sets this bit to indicate a symbolic link.
        const SYMLINK   = 0b00000000_01000000;
        /// These bits are never used
        const RESERVED  = 0b11111111_10000000;
    }
}

impl MsDosAttrs {
    /// Return whether a read-only flag is set
    pub fn is_read_only(self) -> bool {
        self.intersects(MsDosAttrs::READ_ONLY)
    }
    /// Return whether a hidden flag is set
    pub fn is_hidden(self) -> bool {
        self.intersects(MsDosAttrs::HIDDEN)
    }
    /// Return whether a system flag is set
    pub fn is_system(self) -> bool {
        self.intersects(MsDosAttrs::SYSTEM)
    }
    /// Return whether a system flag is set
    pub fn is_volume(self) -> bool {
        self.intersects(MsDosAttrs::VOLUME)
    }
    /// Return whether a system flag is set
    pub fn is_subdir(self) -> bool {
        self.intersects(MsDosAttrs::SUBDIR)
    }
    /// Return whether an archive flag is set
    pub fn is_archive(self) -> bool {
        self.intersects(MsDosAttrs::ARCHIVE)
    }
    /// Return whether a symlink flag is set
    pub fn is_symlink(self) -> bool {
        self.intersects(MsDosAttrs::SYMLINK)
    }
}

impl fmt::Display for MsDosAttrs {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let mut flags: [u8;5] = *b"ADSHR";
        let mask: usize = const {
                    MsDosAttrs::READ_ONLY.
            r#union(MsDosAttrs::HIDDEN).
            r#union(MsDosAttrs::SYSTEM).
            r#union(MsDosAttrs::SUBDIR).
            r#union(MsDosAttrs::ARCHIVE)
            .bits()
        }.into();
        let mut bit: usize = MsDosAttrs::ARCHIVE.bits().into();
        let perm: usize = self.bits().into();
        for ch in flags.iter_mut() {
            if (mask & bit) == 0 {
                bit >>= 1;
            }
            if (perm & bit) == 0 {
                *ch = b'-';
            }
            bit >>= 1;
        }
        let flags = str::from_utf8(&flags).unwrap();
        flags.fmt(f)
    }
}


#[cfg(test)]
mod tests {
    #[cfg(not(feature = "std"))]
    use alloc::string::ToString;
    use super::*;

    #[test]
    fn msdos_attributes_works() {
        assert!(MsDosAttrs::READ_ONLY.is_read_only());
        assert!(MsDosAttrs::HIDDEN.is_hidden());
        assert!(MsDosAttrs::SYSTEM.is_system());
        assert!(MsDosAttrs::VOLUME.is_volume());
        assert!(MsDosAttrs::SUBDIR.is_subdir());
        assert!(MsDosAttrs::ARCHIVE.is_archive());
        assert!(MsDosAttrs::SYMLINK.is_symlink());
        assert!(!MsDosAttrs::empty().is_read_only());
        assert!(!MsDosAttrs::empty().is_hidden());
        assert!(!MsDosAttrs::empty().is_system());
        assert!(!MsDosAttrs::empty().is_volume());
        assert!(!MsDosAttrs::empty().is_subdir());
        assert!(!MsDosAttrs::empty().is_archive());
        assert!(!MsDosAttrs::empty().is_symlink());
        assert_eq!(MsDosAttrs::READ_ONLY.to_string(), "----R");
        assert_eq!(MsDosAttrs::HIDDEN.to_string(),    "---H-");
        assert_eq!(MsDosAttrs::SYSTEM.to_string(),    "--S--");
        assert_eq!(MsDosAttrs::VOLUME.to_string(),    "-----");
        assert_eq!(MsDosAttrs::SUBDIR.to_string(),    "-D---");
        assert_eq!(MsDosAttrs::ARCHIVE.to_string(),   "A----");
        assert_eq!(MsDosAttrs::SYMLINK.to_string(),   "-----");
        assert_eq!(MsDosAttrs::empty().to_string(),   "-----");
        assert_eq!(MsDosAttrs::all().to_string(),     "ADSHR");
        assert_eq!(MsDosAttrs::all().to_string(),     "ADSHR");
        assert_eq!((MsDosAttrs::READ_ONLY|
                    MsDosAttrs::HIDDEN|
                    MsDosAttrs::SYSTEM|
                    MsDosAttrs::SUBDIR|
                    MsDosAttrs::ARCHIVE).to_string(),   "ADSHR");
        assert_eq!((MsDosAttrs::READ_ONLY|
                    MsDosAttrs::ARCHIVE).to_string(),   "A---R");
        assert_eq!((MsDosAttrs::HIDDEN|
                    MsDosAttrs::SYSTEM|
                    MsDosAttrs::SUBDIR).to_string(),    "-DSH-");
    }
}