ds-rom 0.7.0

Library for extracting/building Nintendo DS ROMs.
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use std::{fmt::Display, str::FromStr};

use bytemuck::{Pod, Zeroable};
use serde::{de, Deserialize, Serialize};
use snafu::{Backtrace, Snafu};

/// A fixed-size ASCII string.
#[derive(Clone, Copy)]
pub struct AsciiArray<const N: usize>(pub [u8; N]);

/// Errors related to [`AsciiArray`].
#[derive(Debug, Snafu)]
pub enum AsciiArrayError {
    /// Occurs when an input character is not in ASCII.
    #[snafu(display("the provided string '{string}' contains one or more non-ASCII characters:\n{backtrace}"))]
    NotAscii {
        /// The invalid string.
        string: String,
        /// Backtrace to the source of the error.
        backtrace: Backtrace,
    },
}

impl<const N: usize> FromStr for AsciiArray<N> {
    type Err = AsciiArrayError;

    /// Loads from a `&str`.
    ///
    /// # Errors
    ///
    /// This function will return an error if the string contains a non-ASCII character.
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let mut chars = [0u8; N];
        for (i, ch) in s.chars().take(N).enumerate() {
            if !ch.is_ascii() {
                return NotAsciiSnafu { string: s.to_string() }.fail();
            }
            chars[i] = ch as u8;
        }
        Ok(Self(chars))
    }
}

impl<const N: usize> Default for AsciiArray<N> {
    fn default() -> Self {
        Self([0; N])
    }
}

impl AsciiArray<4> {
    /// Converts a four-character ASCII string to a `u32`.
    pub fn to_le_u32(&self) -> u32 {
        u32::from_le_bytes(self.0)
    }
}

impl<const N: usize> Display for AsciiArray<N> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        for ch in self.0 {
            if ch == 0 {
                break;
            }
            write!(f, "{}", ch as char)?;
        }
        Ok(())
    }
}

impl<const N: usize> Serialize for AsciiArray<N> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serializer.serialize_str(&self.to_string())
    }
}

impl<'de, const N: usize> Deserialize<'de> for AsciiArray<N> {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let string: String = Deserialize::deserialize(deserializer)?;
        Self::from_str(&string).map_err(de::Error::custom)
    }
}

/// A fixed-size 16-bit Unicode string.
#[derive(Clone, Copy)]
pub struct Unicode16Array<const N: usize>(pub [u16; N]);

unsafe impl<const N: usize> Zeroable for Unicode16Array<N> {}
unsafe impl<const N: usize> Pod for Unicode16Array<N> {}

impl<const N: usize> From<&str> for Unicode16Array<N> {
    fn from(string: &str) -> Self {
        let mut chars = [0u16; N];
        let mut i = 0;
        for ch in string.chars() {
            let mut codepoints = [0u16; 2];
            ch.encode_utf16(&mut codepoints);

            let len = if codepoints[1] != 0 { 2 } else { 1 };
            if i + len >= N {
                break;
            }

            for j in 0..len {
                chars[i] = codepoints[j];
                i += 1;
            }
        }
        Self(chars)
    }
}

impl<const N: usize> Display for Unicode16Array<N> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        for ch in self.0 {
            if ch == 0 {
                break;
            }
            let Some(ch) = char::from_u32(ch as u32) else {
                break;
            };
            write!(f, "{ch}")?;
        }
        Ok(())
    }
}

pub(crate) struct BlobSize(pub usize);

impl Display for BlobSize {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let size = self.0;
        match size {
            0..=0x3ff => write!(f, "{}B", size),
            0x400..=0xfffff => write!(f, "{:.1}kB", size as f32 / 0x400 as f32),
            0x100000.. => write!(f, "{:.1}MB", size as f32 / 0x100000 as f32),
        }
    }
}