teamy-mft 0.5.0

TeamDman's Master File Table CLI and library for NTFS.
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

use std::ops::Deref;

/// Index into the list of MFT entries (a.k.a. file reference without the sequence part).
#[derive(Debug, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct MftRecordNumber(u64);

impl MftRecordNumber {
    #[must_use]
    pub const fn new(record_number: u64) -> Self {
        Self(record_number)
    }
    // ---------------------------------------------------------------------
    // Reserved system file record numbers (0–15) as defined by NTFS.
    // These records are guaranteed to exist (though some may be empty on a
    // given volume) and the first 16 slots are reserved for them.
    // ---------------------------------------------------------------------
    /// 0 – $MFT (Master File Table itself)
    pub const DOLLAR_MFT: MftRecordNumber = MftRecordNumber(0);
    /// 1 – $`MFTMirr` (mirror of first 4 records of $MFT)
    pub const DOLLAR_MFT_MIRR: MftRecordNumber = MftRecordNumber(1);
    /// 2 – $`LogFile` (transaction log)
    pub const DOLLAR_LOG_FILE: MftRecordNumber = MftRecordNumber(2);
    /// 3 – $Volume (volume information)
    pub const DOLLAR_VOLUME: MftRecordNumber = MftRecordNumber(3);
    /// 4 – $`AttrDef` (attribute definitions)
    pub const DOLLAR_ATTR_DEF: MftRecordNumber = MftRecordNumber(4);
    /// 5 – Root directory (".")
    pub const MFT_ROOT: MftRecordNumber = MftRecordNumber(5);
    /// 6 – $Bitmap (cluster allocation bitmap)
    pub const DOLLAR_BITMAP: MftRecordNumber = MftRecordNumber(6);
    /// 7 – $Boot (boot sector / volume boot record copy)
    pub const DOLLAR_BOOT: MftRecordNumber = MftRecordNumber(7);
    /// 8 – $`BadClus` (lists bad clusters)
    pub const DOLLAR_BAD_CLUS: MftRecordNumber = MftRecordNumber(8);
    /// 9 – $Secure (security descriptors store)
    pub const DOLLAR_SECURE: MftRecordNumber = MftRecordNumber(9);
    /// 10 – $`UpCase` (uppercase mapping table)
    pub const DOLLAR_UP_CASE: MftRecordNumber = MftRecordNumber(10);
    /// 11 – $Extend (directory containing extend metadata files)
    pub const DOLLAR_EXTEND: MftRecordNumber = MftRecordNumber(11);
    /// 12 – $Quota (user quota information)
    pub const DOLLAR_QUOTA: MftRecordNumber = MftRecordNumber(12);
    /// 13 – $`ObjId` (object IDs)
    pub const DOLLAR_OBJ_ID: MftRecordNumber = MftRecordNumber(13);
    /// 14 – $Reparse (reparse point data)
    pub const DOLLAR_REPARSE: MftRecordNumber = MftRecordNumber(14);
    /// 15 – $`UsnJrnl` (Update Sequence Number change journal)
    pub const DOLLAR_USN_JRNL: MftRecordNumber = MftRecordNumber(15);

    /// Returns true if this record number is within the reserved system file range (0–15 inclusive).
    #[must_use]
    pub const fn is_reserved(self) -> bool {
        self.0 < 16
    }
}
impl std::fmt::Display for MftRecordNumber {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}
impl From<u64> for MftRecordNumber {
    fn from(record_number: u64) -> Self {
        MftRecordNumber(record_number)
    }
}
impl From<u32> for MftRecordNumber {
    fn from(record_number: u32) -> Self {
        MftRecordNumber(u64::from(record_number))
    }
}

impl Deref for MftRecordNumber {
    type Target = u64;
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

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

    #[test]
    fn reserved_constants_are_correct() {
        assert_eq!(*MftRecordNumber::DOLLAR_MFT, 0);
        assert_eq!(*MftRecordNumber::DOLLAR_MFT_MIRR, 1);
        assert_eq!(*MftRecordNumber::DOLLAR_LOG_FILE, 2);
        assert_eq!(*MftRecordNumber::DOLLAR_VOLUME, 3);
        assert_eq!(*MftRecordNumber::DOLLAR_ATTR_DEF, 4);
        assert_eq!(*MftRecordNumber::MFT_ROOT, 5);
        assert_eq!(*MftRecordNumber::DOLLAR_BITMAP, 6);
        assert_eq!(*MftRecordNumber::DOLLAR_BOOT, 7);
        assert_eq!(*MftRecordNumber::DOLLAR_BAD_CLUS, 8);
        assert_eq!(*MftRecordNumber::DOLLAR_SECURE, 9);
        assert_eq!(*MftRecordNumber::DOLLAR_UP_CASE, 10);
        assert_eq!(*MftRecordNumber::DOLLAR_EXTEND, 11);
        assert_eq!(*MftRecordNumber::DOLLAR_QUOTA, 12);
        assert_eq!(*MftRecordNumber::DOLLAR_OBJ_ID, 13);
        assert_eq!(*MftRecordNumber::DOLLAR_REPARSE, 14);
        assert_eq!(*MftRecordNumber::DOLLAR_USN_JRNL, 15);
        assert!(MftRecordNumber::DOLLAR_QUOTA.is_reserved());
        assert!(!MftRecordNumber::from(16u64).is_reserved());
    }
}