rsext4 0.3.0

A lightweight ext4 file system.
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

//! Directory entry parsing and iteration helpers.

/// Parsed directory entry view.
#[derive(Debug)]
pub struct Ext4DirEntryInfo<'a> {
    pub inode: u32,
    pub file_type: u8,
    pub name: &'a [u8],
}

impl<'a> Ext4DirEntryInfo<'a> {
    /// Parses an ext4 directory entry from raw bytes.
    pub fn parse_from_bytes(data: &'a [u8]) -> Option<Self> {
        if data.len() < 8 {
            return None;
        }

        let inode = u32::from_le_bytes([data[0], data[1], data[2], data[3]]);
        if inode == 0 {
            return None;
        }

        let rec_len = u16::from_le_bytes([data[4], data[5]]);
        let name_len = data[6] as usize;
        let file_type = data[7];

        if rec_len < 8 || name_len > 255 || data.len() < 8 + name_len {
            return None;
        }

        let name = &data[8..8 + name_len];

        Some(Ext4DirEntryInfo {
            inode,
            file_type,
            name,
        })
    }

    /// Returns the entry name as UTF-8 when valid.
    pub fn name_str(&self) -> Option<&str> {
        core::str::from_utf8(self.name).ok()
    }

    /// Returns whether the entry is `"."`.
    pub fn is_dot(&self) -> bool {
        self.name == b"."
    }

    /// Returns whether the entry is `".."`.
    pub fn is_dotdot(&self) -> bool {
        self.name == b".."
    }
}

/// Iterator over directory entries in a directory block.
pub struct DirEntryIterator<'a> {
    data: &'a [u8],
    offset: usize,
}

impl<'a> DirEntryIterator<'a> {
    /// Creates a new iterator over a directory block.
    pub fn new(data: &'a [u8]) -> Self {
        Self { data, offset: 0 }
    }
}

impl<'a> Iterator for DirEntryIterator<'a> {
    type Item = (Ext4DirEntryInfo<'a>, u16);

    fn next(&mut self) -> Option<Self::Item> {
        while self.offset < self.data.len() {
            let remaining = &self.data[self.offset..];
            if remaining.len() < 8 {
                return None;
            }

            let rec_len = u16::from_le_bytes([remaining[4], remaining[5]]);
            if rec_len < 8 || rec_len as usize > remaining.len() {
                return None;
            }

            let entry_data = &remaining[..rec_len as usize];
            self.offset += rec_len as usize;

            if let Some(entry_info) = Ext4DirEntryInfo::parse_from_bytes(entry_data) {
                return Some((entry_info, rec_len));
            }
        }

        None
    }
}