sakka 0.0.1

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
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320

use crate::{Decode, Endian, Error, common::alignment};

/// A reader for reading binary data from a byte slice.
pub struct Reader<'a, Ctx = ()> {
    bytes: &'a [u8],
    position: usize,
    endian: Endian,
    context: Ctx,
}

impl<'a, Ctx> Reader<'a, Ctx> {
    /// Creates a new reader with the given data and context.
    #[inline]
    pub const fn new(data: &'a [u8], endian: Endian, context: Ctx) -> Self {
        Self { bytes: data, position: 0, endian, context }
    }

    /// Returns a reference to the underlying context.
    #[inline]
    pub fn context(&self) -> &Ctx {
        &self.context
    }

    /// Returns a mutable reference to the underlying context.
    #[inline]
    pub fn context_mut(&mut self) -> &mut Ctx {
        &mut self.context
    }

    /// Replaces the underlying context with the given one, returning the old context.
    #[inline]
    pub fn replace_context(&mut self, context: Ctx) -> Ctx {
        core::mem::replace(&mut self.context, context)
    }

    /// Returns the endianness of the reader.
    #[inline]
    pub const fn endian(&self) -> Endian {
        self.endian
    }

    /// Returns the total length of the underlying data.
    #[inline]
    pub const fn total_len(&self) -> usize {
        self.bytes.len()
    }

    /// Returns the current position of the reader.
    #[inline]
    pub const fn position(&self) -> usize {
        self.position
    }

    /// Returns the number of bytes remaining to be read.
    #[inline]
    pub const fn remaining(&self) -> usize {
        self.bytes.len().saturating_sub(self.position)
    }

    /// Returns `true` if the reader has reached the end of the underlying data.
    #[inline]
    pub const fn is_eof(&self) -> bool {
        self.remaining() == 0
    }

    /// Returns the data as a slice.
    #[inline]
    pub fn as_slice(&self) -> &'a [u8] {
        self.bytes
    }

    /// Returns the remaining data as a slice.
    #[inline]
    pub fn remaining_slice(&self) -> &'a [u8] {
        &self.bytes[self.position..]
    }

    /// Sets the position of the reader, returning an error if the position is out of bounds.
    #[inline]
    pub fn set_position(&mut self, position: usize) -> Result<(), Error> {
        if position > self.bytes.len() {
            return Err(Error::OutOfBounds);
        }

        self.position = position;
        Ok(())
    }

    /// Seeks the reader by the given offset, returning an error if the new position is out of bounds.
    #[inline]
    pub fn seek(&mut self, offset: isize) -> Result<(), Error> {
        let new_position = if offset < 0 {
            self.position.checked_sub(offset.unsigned_abs())
        } else {
            self.position.checked_add(offset as usize)
        };

        match new_position {
            Some(pos) if pos <= self.bytes.len() => {
                self.position = pos;
                Ok(())
            }
            _ => Err(Error::OutOfBounds),
        }
    }

    /// Skips the given number of bytes, returning an error if the end of the underlying data is
    /// reached.
    #[inline]
    pub fn skip(&mut self, len: usize) -> Result<(), Error> {
        let end = self.position.checked_add(len).ok_or(Error::OutOfBounds)?;

        if end > self.bytes.len() {
            return Err(Error::OutOfBounds);
        }

        self.position = end;
        Ok(())
    }

    /// Aligns the reader's position to the given alignment, returning an error if the alignment
    /// is invalid or if the end of the underlying data is reached.
    #[inline]
    pub fn align(&mut self, alignment: usize) -> Result<(), Error> {
        let padding = alignment::alignment_padding(self.position, alignment)?;
        self.skip(padding)
    }

    /// Returns a slice of the given length, returning an error if the end of the underlying data is
    /// reached.
    #[inline]
    pub fn take(&mut self, len: usize) -> Result<&'a [u8], Error> {
        let start = self.position;
        let end = start.checked_add(len).ok_or(Error::OutOfBounds)?;

        if end > self.bytes.len() {
            return Err(Error::OutOfBounds);
        }

        self.position = end;
        Ok(&self.bytes[start..end])
    }

    /// Reads exactly the given number of bytes into the provided buffer.
    #[inline]
    pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error> {
        let len = buf.len();
        let bytes = self.take(len)?;
        buf.copy_from_slice(bytes);
        Ok(())
    }

    /// Reads exactly the given number of bytes into a fixed-size array.
    #[inline]
    pub fn read_bytes<const N: usize>(&mut self) -> Result<[u8; N], Error> {
        let mut buf = [0u8; N];
        self.read_exact(&mut buf)?;
        Ok(buf)
    }

    /// Reads a value of type `D` from the reader using the `Decode` trait.
    #[inline]
    pub fn read<D: Decode<Ctx>>(&mut self) -> Result<D, Error> {
        D::decode(self)
    }

    /// Peeks at the given number of bytes without advancing the reader's position.
    #[inline]
    pub fn peek(&self, len: usize) -> Result<&'a [u8], Error> {
        let start = self.position;
        let end = start.checked_add(len).ok_or(Error::OutOfBounds)?;

        if end > self.bytes.len() {
            return Err(Error::OutOfBounds);
        }

        Ok(&self.bytes[start..end])
    }

    /// Reads exactly the given number of bytes into the provided buffer without advancing the
    /// reader's position.
    #[inline]
    pub fn peek_exact(&self, buf: &mut [u8]) -> Result<(), Error> {
        let bytes = self.peek(buf.len())?;
        buf.copy_from_slice(bytes);
        Ok(())
    }

    /// Peeks at the given number of bytes and returns them as a fixed-size array.
    #[inline]
    pub fn peek_bytes<const N: usize>(&self) -> Result<[u8; N], Error> {
        let mut buf = [0u8; N];
        self.peek_exact(&mut buf)?;
        Ok(buf)
    }
}

impl<Ctx: Default> Default for Reader<'_, Ctx> {
    fn default() -> Self {
        Self::new(&[], Endian::Little, Ctx::default())
    }
}

#[cfg(test)]
mod tests {
    use super::Reader;
    use crate::{Endian, Error};

    #[test]
    fn new_and_default_have_expected_initial_state() {
        let bytes = [1u8, 2, 3];
        let reader = Reader::new(&bytes, Endian::Big, 9u32);

        assert_eq!(reader.endian(), Endian::Big);
        assert_eq!(reader.total_len(), 3);
        assert_eq!(reader.position(), 0);
        assert_eq!(reader.remaining(), 3);
        assert!(!reader.is_eof());
        assert_eq!(*reader.context(), 9);
        assert_eq!(reader.as_slice(), &bytes);
        assert_eq!(reader.remaining_slice(), &bytes);

        let default_reader = Reader::<u16>::default();
        assert_eq!(default_reader.endian(), Endian::Little);
        assert_eq!(*default_reader.context(), 0);
        assert!(default_reader.is_eof());
    }

    #[test]
    fn context_mut_and_replace_context_work() {
        let mut reader = Reader::new(&[1, 2], Endian::Little, 10i32);

        *reader.context_mut() += 5;
        assert_eq!(*reader.context(), 15);

        let old = reader.replace_context(42);
        assert_eq!(old, 15);
        assert_eq!(*reader.context(), 42);
    }

    #[test]
    fn set_position_seek_and_skip_update_position_and_bounds() {
        let mut reader = Reader::new(&[0, 1, 2, 3, 4], Endian::Little, ());

        reader.set_position(2).unwrap();
        assert_eq!(reader.position(), 2);
        assert_eq!(reader.remaining(), 3);

        reader.seek(2).unwrap();
        assert_eq!(reader.position(), 4);

        reader.seek(-3).unwrap();
        assert_eq!(reader.position(), 1);

        reader.skip(2).unwrap();
        assert_eq!(reader.position(), 3);

        assert!(matches!(reader.set_position(6), Err(Error::OutOfBounds)));
        assert!(matches!(reader.seek(-10), Err(Error::OutOfBounds)));
        assert!(matches!(reader.seek(10), Err(Error::OutOfBounds)));
        assert!(matches!(reader.skip(3), Err(Error::OutOfBounds)));
    }

    #[test]
    fn align_obeys_padding_and_errors() {
        let mut reader = Reader::new(&[0, 1, 2, 3], Endian::Little, ());

        reader.set_position(1).unwrap();
        reader.align(4).unwrap();
        assert_eq!(reader.position(), 4);
        assert!(reader.is_eof());

        let mut invalid = Reader::new(&[0, 1], Endian::Little, ());
        assert!(matches!(invalid.align(0), Err(Error::InvalidAlignment)));
        assert!(matches!(invalid.align(3), Err(Error::InvalidAlignment)));

        let mut oob = Reader::new(&[0, 1, 2], Endian::Little, ());
        oob.set_position(2).unwrap();
        assert!(matches!(oob.align(4), Err(Error::OutOfBounds)));
    }

    #[test]
    fn take_read_exact_and_read_bytes_consume_data() {
        let mut reader = Reader::new(&[10, 11, 12, 13], Endian::Little, ());

        assert_eq!(reader.take(2).unwrap(), &[10, 11]);
        assert_eq!(reader.position(), 2);

        let mut buf = [0u8; 1];
        reader.read_exact(&mut buf).unwrap();
        assert_eq!(buf, [12]);
        assert_eq!(reader.position(), 3);

        let arr = reader.read_bytes::<1>().unwrap();
        assert_eq!(arr, [13]);
        assert!(reader.is_eof());

        assert!(matches!(reader.take(1), Err(Error::OutOfBounds)));
    }

    #[test]
    fn peek_variants_do_not_advance_position() {
        let mut reader = Reader::new(&[21, 22, 23, 24], Endian::Little, ());
        reader.set_position(1).unwrap();

        assert_eq!(reader.peek(2).unwrap(), &[22, 23]);
        assert_eq!(reader.position(), 1);

        let mut buf = [0u8; 2];
        reader.peek_exact(&mut buf).unwrap();
        assert_eq!(buf, [22, 23]);
        assert_eq!(reader.position(), 1);

        let arr = reader.peek_bytes::<3>().unwrap();
        assert_eq!(arr, [22, 23, 24]);
        assert_eq!(reader.position(), 1);

        assert!(matches!(reader.peek(5), Err(Error::OutOfBounds)));
    }
}