bdat 0.6.0

(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
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

pub(crate) mod detect;
pub(crate) mod legacy;
pub(crate) mod modern;

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 Xenoblade 3D and
/// 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;

/// The major categorization of the different BDAT formats.
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum BdatVersion {
    /// Used in all games prior to XC3
    Legacy(LegacyVersion),
    /// Used in XC3
    Modern,
}

/// Subversion for legacy table formats.
///
/// The high-level format (i.e. [`LegacyTable`]) is the same
/// for all of these. Only some parts of the internal binary representation
/// are different.
///
/// [`LegacyTable`]: crate::legacy::LegacyTable
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum LegacyVersion {
    /// Used in XC1 (Wii)
    Wii,
    /// Used in XC3D (New 3DS)
    New3ds,
    /// Used in XC2/XCDE
    Switch,
    /// Used in XCX
    X,
}

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()
    }
}

impl LegacyVersion {
    /// Returns the size in bytes of the table header.
    pub(crate) const fn table_header_size(&self) -> usize {
        if self.is_wii_table_format() {
            legacy::HEADER_SIZE_WII
        } else {
            legacy::HEADER_SIZE
        }
    }

    pub(crate) const fn is_wii_table_format(&self) -> bool {
        matches!(self, Self::Wii | Self::New3ds)
    }
}

impl From<LegacyVersion> for BdatVersion {
    fn from(value: LegacyVersion) -> Self {
        Self::Legacy(value)
    }
}