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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
use std::iter::FusedIterator;
use std::mem::size_of;
use std::ops::Deref;
use std::ptr::slice_from_raw_parts;

use crate::{FixedSized, SubRecord};

/// This allows us to either wrap an existing &[T] slice to serialize it OR to store a raw byte
/// slice from an encoding and access its potentially unaligned values.
///
/// **Warning:** Creating Raw arrays manually may lead to undefined behavior, use `from_raw`.
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum SliceWrapper<'a, T: FixedSized> {
    Raw(&'a [u8]),
    Cooked(&'a [T]),
}

impl<'a, T, A> From<A> for SliceWrapper<'a, T>
where
    T: FixedSized,
    A: AsRef<&'a [T]>,
{
    #[inline]
    fn from(array: A) -> Self {
        SliceWrapper::from_cooked(array.as_ref())
    }
}

impl<'a> Deref for SliceWrapper<'a, u8> {
    type Target = &'a [u8];

    #[inline]
    fn deref(&self) -> &Self::Target {
        match self {
            SliceWrapper::Raw(d) => d,
            SliceWrapper::Cooked(d) => d,
        }
    }
}

impl<'a> AsRef<[u8]> for SliceWrapper<'a, u8> {
    #[inline]
    fn as_ref(&self) -> &'a [u8] {
        **self
    }
}

impl<'a, T> SliceWrapper<'a, T>
where
    T: FixedSized,
{
    /// Take in a little-endian array. Most not include size bytes since the slice already has that
    /// info.
    pub fn from_raw(bytes: &'a [u8]) -> Self {
        assert_eq!(bytes.len() % size_of::<T>(), 0);
        Self::Raw(bytes)
    }

    pub fn from_cooked(array: &'a [T]) -> Self {
        SliceWrapper::Cooked(array)
    }
}

impl<'a, T> SliceWrapper<'a, T>
where
    T: FixedSized + SubRecord<'a>,
{
    /// Retrieve a value at a given index
    pub fn get(&self, i: usize) -> Option<T> {
        match *self {
            SliceWrapper::Raw(raw) => {
                if i * size_of::<T>() + size_of::<T>() > raw.len() {
                    None
                } else {
                    let raw: &'a [u8] = unsafe {
                        &*slice_from_raw_parts(
                            raw.as_ptr().add(i * size_of::<T>()),
                            size_of::<T>(),
                        )
                    };
                    Some(T::_deserialize_chained(raw).map(|(_, v)| v).unwrap())
                }
            }
            SliceWrapper::Cooked(ary) => ary.get(i).copied(),
        }
    }

    pub fn iter(&self) -> Iter<'a, T> {
        self.into_iter()
    }
}

impl<'a, T> SliceWrapper<'a, T>
where
    T: FixedSized,
{
    pub fn is_raw(&self) -> bool {
        matches!(self, SliceWrapper::Raw(_))
    }
}

impl<'a, T> SliceWrapper<'a, T>
where
    T: FixedSized,
{
    /// Retrieve the number of items
    #[inline]
    pub fn len(&self) -> usize {
        match *self {
            SliceWrapper::Raw(raw) => raw.len() / size_of::<T>(),
            SliceWrapper::Cooked(ary) => ary.len(),
        }
    }

    #[inline]
    pub fn is_empty(&self) -> bool {
        match *self {
            SliceWrapper::Raw(raw) => raw.is_empty(),
            SliceWrapper::Cooked(ary) => ary.is_empty(),
        }
    }

    /// Retrieve the total size of this slice's data in bytes. Does not include any extra bytes to
    /// define the length of the array so it is not the same as the serialized size.
    #[inline]
    pub fn size(&self) -> usize {
        match *self {
            SliceWrapper::Raw(raw) => raw.len(),
            SliceWrapper::Cooked(ary) => ary.len() * size_of::<T>(),
        }
    }
}

impl<'a, T> IntoIterator for SliceWrapper<'a, T>
where
    T: FixedSized + SubRecord<'a>,
{
    type Item = T;
    type IntoIter = Iter<'a, T>;

    #[inline]
    fn into_iter(self) -> Self::IntoIter {
        Iter(self, 0)
    }
}

pub struct Iter<'a, T: FixedSized>(SliceWrapper<'a, T>, usize);

impl<'a, T> Iterator for Iter<'a, T>
where
    T: FixedSized + SubRecord<'a>,
{
    type Item = T;

    fn next(&mut self) -> Option<T> {
        let r = self.0.get(self.1);
        self.1 += 1;
        r
    }
}

impl<'a, T> FusedIterator for Iter<'a, T> where T: FixedSized + SubRecord<'a> {}
impl<'a, T> ExactSizeIterator for Iter<'a, T>
where
    T: FixedSized + SubRecord<'a>,
{
    fn len(&self) -> usize {
        debug_assert!(self.1 <= self.0.len());
        self.0.len() - self.1
    }
}

#[cfg(test)]
mod test {
    use std::convert::TryInto;

    use crate::{
        define_serialize_chained, packed_read, DeResult, FixedSized, SliceWrapper,
        SubRecord,
    };

    #[repr(packed)]
    #[derive(Debug, Eq, PartialEq, Copy, Clone)]
    struct Fixed {
        a: u8,
        b: u64,
    }

    impl FixedSized for Fixed {}

    fn cooked_array() -> &'static [Fixed] {
        &[
            Fixed { a: 23, b: 98072396 },
            Fixed {
                a: 134,
                b: 2389502334,
            },
            Fixed { a: 73, b: 98273 },
            Fixed { a: 1, b: 59125 },
        ]
    }

    impl<'raw> SubRecord<'raw> for Fixed {
        const MIN_SERIALIZED_SIZE: usize = Self::SERIALIZED_SIZE;
        const EXACT_SERIALIZED_SIZE: Option<usize> = Some(Self::SERIALIZED_SIZE);

        fn serialized_size(&self) -> usize {
            Self::SERIALIZED_SIZE
        }

        define_serialize_chained!(*Fixed => |zelf, dest| {
            Ok(zelf.a._serialize_chained(dest)? + packed_read!(zelf.b)._serialize_chained(dest)?)
        });

        fn _deserialize_chained(raw: &'raw [u8]) -> DeResult<(usize, Self)> {
            Ok((
                9,
                Self {
                    a: raw[0],
                    b: u64::from_le_bytes((raw[1..9]).try_into().unwrap()),
                },
            ))
        }
    }

    #[test]
    fn from_raw() {
        // make sure it checks the size of the array is correct
        let s = <SliceWrapper<u16>>::from_raw(&[0x00, 0x00, 0x00, 0x00]);
        assert!(!s.is_empty());
    }

    #[test]
    #[should_panic]
    fn from_raw_err() {
        // make sure it checks the size of the array is correct
        let s = <SliceWrapper<u16>>::from_raw(&[0x00, 0x00, 0x00]);
        assert!(!s.is_empty());
    }

    #[test]
    fn get_cooked_fixed_struct() {
        let array = cooked_array();
        let s = SliceWrapper::Cooked(array);
        for i in 0..array.len() {
            assert_eq!(s.get(i).unwrap(), array[i]);
        }
    }

    #[test]
    fn get_cooked_primitive() {
        let array: &'static [u16] = &[0x0000, 0x1243, 0x8f90, 0x097a];
        let s = SliceWrapper::Cooked(array);
        for i in 0..array.len() {
            assert_eq!(s.get(i).unwrap(), array[i]);
        }
    }

    #[test]
    fn get_raw_fixed_struct() {
        // only happens for big-endian systems or systems where `repr(packed)` is not supported
        let s = <SliceWrapper<Fixed>>::Raw(&[0x01, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
        let s0 = s.get(0).unwrap();
        assert_eq!(packed_read!(s0.a), 1);
        assert_eq!(packed_read!(s0.b), 2);
    }

    #[test]
    fn get_raw_primitive() {
        // only happens for multi-byte values
        let s = <SliceWrapper<u16>>::Raw(&[0x01, 0x00, 0x02, 0x00]);
        assert_eq!(s.get(0).unwrap(), 1);
        assert_eq!(s.get(1).unwrap(), 2);
    }

    #[test]
    fn iter_cooked() {
        let array = cooked_array();
        let s = SliceWrapper::Cooked(array);
        for (i, v) in s.iter().enumerate() {
            assert_eq!(v, array[i]);
        }
    }

    #[test]
    fn iter_raw() {
        let s = <SliceWrapper<Fixed>>::Raw(&[
            0x01, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x04, 0x00, 0x00, 0x00,
            0x00, 0x00, 0x00, 0x00,
        ]);
        for (i, v) in s.iter().enumerate() {
            assert_eq!(packed_read!(v.a), (i * 2 + 1) as u8);
            assert_eq!(packed_read!(v.b), (i * 2 + 2) as u64);
        }
    }

    #[test]
    fn size_cooked_struct() {
        let s = SliceWrapper::Cooked(cooked_array());
        assert_eq!(s.len(), 4);
        assert_eq!(s.size(), 9 * 4);
    }

    #[test]
    fn size_raw_struct() {
        let s = <SliceWrapper<Fixed>>::Raw(&[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
        assert_eq!(s.len(), 1);
        assert_eq!(s.size(), 9);
    }

    #[test]
    fn size_cooked_primitive() {
        let s = <SliceWrapper<u16>>::Cooked(&[0x0000, 0x0000, 0x0000]);
        assert_eq!(s.len(), 3);
        assert_eq!(s.size(), 6);
    }

    #[test]
    fn size_raw_primitive() {
        let s = <SliceWrapper<u16>>::Raw(&[0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
        assert_eq!(s.len(), 3);
        assert_eq!(s.size(), 6);
    }

    #[test]
    fn deref_u8_raw() {
        let s = <SliceWrapper<u8>>::Raw(&[0x00, 0x01, 0x04, 0x06]);
        let s2: &[u8] = *s;
        assert_eq!(s2[0], 0);
        assert_eq!(s2[1], 1);
        assert_eq!(s2[2], 4);
        assert_eq!(s2[3], 6);
    }

    #[test]
    fn deref_u8_cooked() {
        let s = <SliceWrapper<u8>>::Cooked(&[0x00, 0x01, 0x04, 0x06]);
        let s2: &[u8] = *s;
        assert_eq!(s2[0], 0);
        assert_eq!(s2[1], 1);
        assert_eq!(s2[2], 4);
        assert_eq!(s2[3], 6);
    }
}