sakka 0.0.5

A low-level framework for implementing binary file format parsers and writers.
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

use crate::{Decode, Encode, ReadCollection, Reader, WriteCollection, Writer};

impl<Ctx, T, const N: usize> Encode<Ctx> for [T; N]
where
    T: Encode<Ctx>,
{
    type Error = T::Error;

    fn encode(&self, writer: &mut Writer<Ctx>) -> Result<(), Self::Error> {
        writer.write_slice(self)
    }
}

impl<Ctx, T, const N: usize> Decode<Ctx> for [T; N]
where
    T: Decode<Ctx>,
{
    type Error = T::Error;

    fn decode(reader: &mut Reader<'_, Ctx>) -> Result<Self, Self::Error> {
        reader.read_array()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::Endian;

    #[test]
    fn encode_array_of_primitives() {
        let array: [u32; 3] = [0x1234_5678, 0xABCD_EF00, 0x0011_2233];
        let mut writer = Writer::new(Endian::Little, ());
        array.encode(&mut writer).unwrap();

        let bytes = writer.finish();
        // 3 * 4 bytes = 12 bytes
        assert_eq!(bytes.len(), 12);
    }

    #[test]
    fn decode_array_of_primitives() {
        let data: [u8; 12] = [
            0x78, 0x56, 0x34, 0x12, // 0x1234_5678 (little endian)
            0x00, 0xEF, 0xCD, 0xAB, // 0xABCD_EF00 (little endian)
            0x33, 0x22, 0x11, 0x00, // 0x0011_2233 (little endian)
        ];

        let mut reader = Reader::new(&data, Endian::Little, ());
        let array: [u32; 3] = reader.read_array().unwrap();

        assert_eq!(array, [0x1234_5678, 0xABCD_EF00, 0x0011_2233]);
    }

    #[test]
    fn roundtrip_array_of_primitives() {
        let original: [u16; 5] = [0x1234, 0x5678, 0xABCD, 0xEF00, 0x0011];

        let mut writer = Writer::new(Endian::Big, ());
        original.encode(&mut writer).unwrap();
        let bytes = writer.finish();

        let mut reader = Reader::new(&bytes, Endian::Big, ());
        let decoded: [u16; 5] = reader.read_array().unwrap();

        assert_eq!(decoded, original);
    }

    #[test]
    fn encode_array_of_u8() {
        let array: [u8; 4] = [0x12, 0x34, 0x56, 0x78];
        let mut writer = Writer::new(Endian::Little, ());
        array.encode(&mut writer).unwrap();

        let bytes = writer.finish();
        assert_eq!(bytes, &[0x12, 0x34, 0x56, 0x78]);
    }

    #[test]
    fn decode_array_of_u8() {
        let data = [0xAA, 0xBB, 0xCC, 0xDD, 0xEE];

        let mut reader = Reader::new(&data, Endian::Little, ());
        let array: [u8; 5] = reader.read_array().unwrap();

        assert_eq!(array, [0xAA, 0xBB, 0xCC, 0xDD, 0xEE]);
    }

    #[test]
    fn roundtrip_array_of_u8() {
        let original: [u8; 3] = [0x11, 0x22, 0x33];

        let mut writer = Writer::new(Endian::Little, ());
        original.encode(&mut writer).unwrap();
        let bytes = writer.finish();

        let mut reader = Reader::new(&bytes, Endian::Little, ());
        let decoded: [u8; 3] = reader.read_array().unwrap();

        assert_eq!(decoded, original);
    }
}