embedded-exfat 0.4.0

ExFAT filesystem library with async support, mainly focusing on embedded 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

use core::mem::MaybeUninit;

use derive_more::Display;

use crate::file::MAX_FILENAME_SIZE;
use crate::fs::{self, SectorIndex};
use crate::region::data::entryset::primary::FileDirectory;
use crate::region::data::entryset::secondary::{Secondary, StreamExtension};
use crate::types::SectorID;

#[derive(Copy, Clone, Debug, Display, Eq, Ord, PartialEq, PartialOrd)]
#[display("{}:{}", sector_id, index)]
pub(crate) struct EntryID {
    pub sector_id: SectorID,
    pub index: u8, // Max sector size / enty size = 4096 / 32 = 128
}

#[derive(Copy, Clone, Debug, Default, Display)]
#[display("{}.{}", sector_index, index)]
pub(crate) struct EntryIndex {
    pub sector_index: SectorIndex,
    pub index: u8, // Within sector
}

impl EntryIndex {
    pub fn new(sector_index: SectorIndex, index: u8) -> Self {
        Self { sector_index, index }
    }
}

#[derive(Clone)]
pub struct EntrySet {
    pub(crate) name_bytes: [u8; MAX_FILENAME_SIZE],
    pub(crate) name_length: u8,
    pub file_directory: FileDirectory,
    pub stream_extension: Secondary<StreamExtension>,
    pub(crate) entry_index: EntryIndex,
}

impl Default for EntrySet {
    fn default() -> Self {
        let bytes: MaybeUninit<[u8; MAX_FILENAME_SIZE]> = MaybeUninit::uninit();
        Self {
            name_bytes: unsafe { bytes.assume_init() },
            name_length: 0,
            file_directory: Default::default(),
            stream_extension: Default::default(),
            entry_index: Default::default(),
        }
    }
}

impl EntrySet {
    pub fn name(&self) -> &str {
        unsafe { core::str::from_utf8_unchecked(&self.name_bytes[..self.name_length as usize]) }
    }

    pub fn in_use(&self) -> bool {
        self.file_directory.entry_type.in_use()
    }

    pub fn data_length(&self) -> u64 {
        self.stream_extension.data_length.to_ne()
    }

    pub fn valid_data_length(&self) -> u64 {
        let valid_data_length = self.stream_extension.custom_defined.valid_data_length;
        valid_data_length.to_ne()
    }

    pub(crate) fn id(&self, fs_info: &fs::Info) -> EntryID {
        let sector_id = self.entry_index.sector_index.id(fs_info);
        EntryID { sector_id, index: self.entry_index.index }
    }
}