gba_save 0.4.0

Tools for interacting with backup media on Game Boy Advance cartridges.
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

use core::ops::{Bound, RangeBounds};
use deranged::RangedUsize;

pub(crate) fn translate_range_to_buffer<const MAX: usize, Range>(
    range: Range,
    address_offset: *mut u8,
) -> (*mut u8, usize)
where
    Range: RangeBounds<RangedUsize<0, MAX>>,
{
    let offset = match range.start_bound() {
        Bound::Included(start) => start.get(),
        Bound::Excluded(start) => start.get() + 1,
        Bound::Unbounded => 0,
    };
    let address = unsafe { address_offset.add(offset) };
    let len = match range.end_bound() {
        Bound::Included(end) => end.get() + 1,
        Bound::Excluded(end) => end.get(),
        Bound::Unbounded => MAX + 1,
    } - offset;
    (address, len)
}

#[cfg(test)]
mod tests {
    use super::translate_range_to_buffer;
    use deranged::RangedUsize;
    use gba_test::test;
    use more_ranges::{
        RangeFromExclusive, RangeFromExclusiveToExclusive, RangeFromExclusiveToInclusive,
    };

    // SRAM memory location, which is fine to use for the tests.
    const MEMORY: *mut u8 = 0x0e00_0000 as *mut u8;

    #[test]
    fn unbounded_unbounded() {
        assert_eq!(
            translate_range_to_buffer::<32767, _>(.., MEMORY),
            (MEMORY, 32768)
        );
    }

    #[test]
    fn unbounded_included() {
        assert_eq!(
            translate_range_to_buffer::<32767, _>(..=RangedUsize::new_static::<42>(), MEMORY),
            (MEMORY, 43)
        );
    }

    #[test]
    fn unbounded_excluded() {
        assert_eq!(
            translate_range_to_buffer::<32767, _>(..RangedUsize::new_static::<42>(), MEMORY),
            (MEMORY, 42)
        );
    }

    #[test]
    fn included_unbounded() {
        assert_eq!(
            translate_range_to_buffer::<32767, _>(RangedUsize::new_static::<42>().., MEMORY),
            (unsafe { MEMORY.add(42) }, 32726)
        );
    }

    #[test]
    fn included_included() {
        assert_eq!(
            translate_range_to_buffer::<32767, _>(
                RangedUsize::new_static::<42>()..=RangedUsize::new_static::<100>(),
                MEMORY
            ),
            (unsafe { MEMORY.add(42) }, 59)
        );
    }

    #[test]
    fn included_excluded() {
        assert_eq!(
            translate_range_to_buffer::<32767, _>(
                RangedUsize::new_static::<42>()..RangedUsize::new_static::<100>(),
                MEMORY
            ),
            (unsafe { MEMORY.add(42) }, 58)
        );
    }

    #[test]
    fn excluded_unbounded() {
        assert_eq!(
            translate_range_to_buffer::<32767, _>(
                RangeFromExclusive {
                    start: RangedUsize::new_static::<42>()
                },
                MEMORY
            ),
            (unsafe { MEMORY.add(43) }, 32725)
        );
    }

    #[test]
    fn excluded_included() {
        assert_eq!(
            translate_range_to_buffer::<32767, _>(
                RangeFromExclusiveToInclusive {
                    start: RangedUsize::new_static::<42>(),
                    end: RangedUsize::new_static::<100>()
                },
                MEMORY
            ),
            (unsafe { MEMORY.add(43) }, 58)
        );
    }

    #[test]
    fn excluded_excluded() {
        assert_eq!(
            translate_range_to_buffer::<32767, _>(
                RangeFromExclusiveToExclusive {
                    start: RangedUsize::new_static::<42>(),
                    end: RangedUsize::new_static::<100>()
                },
                MEMORY
            ),
            (unsafe { MEMORY.add(43) }, 57)
        );
    }
}