bdat 0.4.0-alpha

(De)serialization library for Monolithsoft's BDAT file format
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

pub mod legacy;
pub mod modern;

pub(crate) mod detect;

mod read;

pub use read::BdatFile;

const BDAT_MAGIC: [u8; 4] = [b'B', b'D', b'A', b'T'];

/// Alias for [`byteorder::LittleEndian`], i.e. the byte order used in the Switch games.
pub type SwitchEndian = byteorder::LittleEndian;
/// Alias for [`byteorder::BigEndian`], i.e. the byte order used in the Wii/Wii U games.
pub type WiiEndian = byteorder::BigEndian;

#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum BdatVersion {
    /// Used in XC1 (Wii)
    LegacyWii,
    /// Used in XC2/XCDE
    LegacySwitch,
    /// Used in XCX
    LegacyX,
    /// Used in XC3
    Modern,
}

impl BdatVersion {
    pub fn is_legacy(&self) -> bool {
        *self != BdatVersion::Modern
    }

    pub fn is_modern(&self) -> bool {
        !self.is_legacy()
    }

    /// Gets whether the version forces labels to be hashed.
    pub fn are_labels_hashed(&self) -> bool {
        self.is_modern()
    }

    /// Returns the size in bytes of the table header.
    pub const fn table_header_size(&self) -> usize {
        match self {
            BdatVersion::Modern => 48,
            BdatVersion::LegacyWii => legacy::HEADER_SIZE_WII,
            _ => legacy::HEADER_SIZE,
        }
    }
}