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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
use crate::WireError;
use core::{mem, str};
#[cfg(feature = "std")]
use std::io;

const UTF8_DECODE_ERROR: &'static str = "failed to decode UTF8--invalid character sequence";

#[cfg(feature = "std")]
type VectoredBuf<'a> = &'a [io::IoSlice<'a>];
#[cfg(not(feature = "std"))]
type VectoredBuf<'a> = &'a [&'a [u8]];

pub trait WireReadable: Sized {
    fn from_wire<const E: bool>(curs: &mut WireCursor<'_>) -> Result<Self, WireError>;

    // Add once try_from_fn is stabilized
    /*
    fn array_from_wire<const L: usize, const E: bool>(curs: &mut WireCursor<'_>) -> Result<[Self; L], WireError> {
        std::array::try_from_fn(|_| { Self::from_wire::<E>(curs) })
    }
    */
}

// Can contain both owned types and references. Useful for structs that have both byte buffers (&'a [u8]) and values (u16, i32, etc)
pub trait CompWireReadable<'a>: Sized {
    fn from_wire_comp<const E: bool>(curs: &mut WireCursor<'a>) -> Result<Self, WireError>;

    // Add once try_from_fn is stabilized
    /*
    fn array_from_wire<const L: usize, const E: bool>(curs: &mut WireCursor<'_>) -> Result<[Self; L], WireError> {
        std::array::try_from_fn(|_| { Self::from_wire::<E>(curs) })
    }
    */
}

pub trait PartWireReadable: Sized {
    fn from_wire_part<const L: usize, const E: bool>(
        curs: &mut WireCursor<'_>,
    ) -> Result<Self, WireError>;
}

pub trait RefWireReadable {
    fn from_wire_ref<'a>(curs: &mut WireCursor<'a>, size: usize) -> Result<&'a Self, WireError>;
}

pub trait VectoredReadable: Sized {
    fn from_vectored<const E: bool>(curs: &mut VectoredCursor<'_>) -> Result<Self, WireError>;

    /*
    fn array_from_vectored<const L: usize, const E: bool>(curs: &mut VectoredCursor<'_>) -> Result<[Self; L], WireError> {
        std::array::try_from_fn(|_| { Self::from_vectored::<E>(curs) })
    }
    */
}

pub trait PartVectoredReadable: Sized {
    fn from_vectored_part<const L: usize, const E: bool>(
        curs: &mut VectoredCursor<'_>,
    ) -> Result<Self, WireError>;
}

pub trait RefVectoredReadable {
    fn from_vectored_ref<'a, const E: bool>(
        curs: &mut VectoredCursor<'_>,
        size: usize,
    ) -> Result<&'a Self, WireError>;
}

#[derive(Clone, Copy)]
pub struct WireCursor<'a> {
    wire: &'a [u8],
}

impl<'a> WireCursor<'a> {
    pub fn new(wire: &'a [u8]) -> Self {
        WireCursor { wire: wire }
    }

    pub fn get_readable<T, const E: bool>(&mut self) -> Result<T, WireError>
    where
        T: WireReadable,
    {
        T::from_wire::<E>(self)
    }

    pub fn get_readable_part<T, const L: usize, const E: bool>(&mut self) -> Result<T, WireError>
    where
        T: PartWireReadable,
    {
        T::from_wire_part::<L, E>(self)
    }

    pub fn get_readable_ref<T, const E: bool>(&mut self, length: usize) -> Result<&'a T, WireError>
    where
        T: RefWireReadable + ?Sized,
    {
        T::from_wire_ref(self, length)
    }

    pub fn get_readable_comp<T, const E: bool>(&mut self) -> Result<T, WireError>
    where
        T: CompWireReadable<'a> + ?Sized,
    {
        T::from_wire_comp::<E>(self)
    }

    pub fn advance(&mut self, amount: usize) -> Result<(), WireError> {
        self.wire = match self.wire.get(amount..) {
            Some(w) => w,
            None => return Err(WireError::InsufficientBytes),
        };
        Ok(())
    }

    pub fn advance_up_to(&mut self, amount: usize) {
        self.wire = match self.wire.get(amount..) {
            Some(w) => w,
            None => &[],
        };
    }

    pub fn get(&mut self, amount: usize) -> Result<&'a [u8], WireError> {
        // self.wire.try_split_at() would be cleaner, but doesn't exist as an API yet...
        match (self.wire.get(0..amount), self.wire.get(amount..)) {
            (Some(r), Some(w)) => {
                self.wire = w;
                Ok(r)
            }
            _ => Err(WireError::InsufficientBytes),
        }
    }

    pub fn get_array<const L: usize>(&mut self) -> Result<&'a [u8; L], WireError> {
        //self.wire.try_split_array_ref() would be cleaner, but doesn't exist as an API yet...
        match (self.wire.get(0..L), self.wire.get(L..)) {
            (Some(r), Some(w)) => {
                self.wire = w;
                r.try_into().or_else(|_| Err(WireError::Internal))
            }
            _ => Err(WireError::InsufficientBytes),
        }
    }

    pub fn is_empty(&self) -> bool {
        self.wire.is_empty()
    }

    pub fn remaining(&self) -> usize {
        self.wire.len()
    }
}

#[derive(Clone, Copy)]
pub struct VectoredCursor<'a> {
    wire: VectoredBuf<'a>,
    idx: usize,
}

impl<'a> VectoredCursor<'a> {
    pub fn new(wire: VectoredBuf<'a>) -> Self {
        VectoredCursor { wire: wire, idx: 0 }
    }

    pub fn is_empty(&self) -> bool {
        let mut tmp_wire = self.wire;
        let mut tmp_idx = self.idx;
        while let Some((first, next_slices)) = tmp_wire.split_first() {
            if tmp_idx < first.len() {
                return false;
            } else {
                tmp_idx = 0;
                tmp_wire = next_slices;
            }
        }

        true
    }

    pub fn get_next(&mut self) -> Result<u8, WireError> {
        while let Some((first, next_slices)) = self.wire.split_first() {
            match first.get(self.idx) {
                Some(val) => {
                    self.idx += 1;
                    return Ok(*val);
                }
                None => {
                    self.idx = 0;
                    self.wire = next_slices;
                }
            }
        }

        Err(WireError::InsufficientBytes)
    }

    pub fn try_get(&mut self, amount: usize) -> Option<&[u8]> {
        while let Some((first, next_slices)) = self.wire.split_first() {
            if self.idx >= first.len() {
                self.idx = 0;
                self.wire = next_slices;
                continue;
            }

            let end_idx = match self.idx.checked_add(amount) {
                Some(i) => i,
                None => return None, // Can't have a slice of length greater than `usize::MAX`
            };

            match first.get(self.idx..end_idx) {
                Some(slice) => {
                    self.idx += amount;
                    return Some(slice);
                }
                None => return None,
            }
        }

        None
    }

    pub fn try_get_array<const L: usize>(&mut self) -> Option<&[u8; L]> {
        match self.try_get(L) {
            Some(arr) => arr.try_into().ok(), // Invariant: should always be Ok
            None => None,
        }
    }

    pub fn remaining(&self) -> usize {
        self.wire
            .iter()
            .map(|s| s.len())
            .sum::<usize>()
            .checked_sub(self.idx)
            .unwrap_or(0)
    }

    pub fn skip(&mut self, mut amount: usize) -> Result<(), WireError> {
        while let Some((first, next_slices)) = self.wire.split_first() {
            let remaining_slice_len = match first.len().checked_sub(self.idx) {
                None | Some(0) => {
                    // Invariant: None should never occur, as the index should never exceed the bound of the first slice
                    self.wire = next_slices;
                    self.idx = 0;
                    continue;
                }
                Some(l) => l,
            };

            match amount.checked_sub(remaining_slice_len) {
                Some(0) => {
                    self.wire = next_slices;
                    self.idx = 0;
                    return Ok(());
                }
                Some(new_amount) => {
                    self.wire = next_slices;
                    self.idx = 0;
                    amount = new_amount;
                }
                None => {
                    self.idx += amount; // Invariant: cannot overflow (as you cannot have a slice greater than `usize::MAX`)
                    return Ok(());
                }
            }
        }

        Err(WireError::InsufficientBytes)
    }
}

pub struct WireReader<'a, const E: bool = true> {
    curs: WireCursor<'a>,
}

impl<'a, const E: bool> WireReader<'a, E> {
    pub fn new(bytes: &'a [u8]) -> Self {
        WireReader {
            curs: WireCursor::new(bytes),
        }
    }

    pub fn new_with_endianness<const F: bool>(bytes: &'a [u8]) -> WireReader<'a, F> {
        WireReader::<F> {
            curs: WireCursor::new(bytes),
        }
    }

    pub fn advance(&mut self, amount: usize) -> Result<(), WireError> {
        self.curs.advance(amount)
    }

    pub fn advance_up_to(&mut self, amount: usize) {
        self.curs.advance_up_to(amount)
    }

    pub fn finalize(&self) -> Result<(), WireError> {
        if !self.is_empty() {
            Err(WireError::ExtraBytes)
        } else {
            Ok(())
        }
    }

    pub fn is_empty(&self) -> bool {
        self.curs.is_empty()
    }

    pub fn peek<T>(&self) -> Result<T, WireError>
    where
        T: WireReadable,
    {
        let mut temp_curs = self.curs;
        T::from_wire::<E>(&mut temp_curs)
    }

    pub fn peek_sized<T>(&self, size: usize) -> Result<&'a T, WireError>
    where
        T: RefWireReadable + ?Sized,
    {
        let mut temp_curs = self.curs;
        T::from_wire_ref(&mut temp_curs, size)
    }

    pub fn read<T>(&mut self) -> Result<T, WireError>
    where
        T: WireReadable,
    {
        T::from_wire::<E>(&mut self.curs)
    }

    // add once array_from_wire is added
    /*
    pub fn read_array<T, const L: usize>(&mut self) -> Result<[T; L], WireError>
    where T: WireReadable {
        T::array_from_wire::<L, E>(self.curs)
    }
    */

    pub fn read_and_finalize<T>(&mut self) -> Result<T, WireError>
    where
        T: WireReadable,
    {
        let ret = self.read()?;
        self.finalize()?;
        Ok(ret)
    }

    pub fn read_part<T, const L: usize>(&mut self) -> Result<T, WireError>
    where
        T: PartWireReadable,
    {
        T::from_wire_part::<L, E>(&mut self.curs)
    }

    pub fn read_ref<T>(&mut self, size: usize) -> Result<&'a T, WireError>
    where
        T: RefWireReadable + ?Sized,
    {
        T::from_wire_ref(&mut self.curs, size)
    }

    pub fn read_comp<T>(&mut self) -> Result<T, WireError>
    where
        T: CompWireReadable<'a>,
    {
        T::from_wire_comp::<E>(&mut self.curs)
    }

    /*
    pub fn read_array_and_finalize<T, const L: usize>(&mut self) -> Result<[T; L], WireError>
    where T: WireReadable {
        let ret = self.read_array()?;
        self.finalize()?;
        Ok(ret)
    }
    */

    pub fn read_remaining<T>(&mut self) -> Result<&'a T, WireError>
    where
        T: RefWireReadable + ?Sized,
    {
        self.read_ref(self.curs.remaining())
    }
}

pub struct VectoredReader<'a, const E: bool = true> {
    curs: VectoredCursor<'a>,
}

impl<'a, const E: bool> VectoredReader<'a, E> {
    pub fn new(bytes: VectoredBuf<'a>) -> Self {
        VectoredReader {
            curs: VectoredCursor::new(bytes),
        }
    }

    pub fn new_with_endianness<const F: bool>(bytes: VectoredBuf<'a>) -> VectoredReader<'a, F> {
        VectoredReader::<F> {
            curs: VectoredCursor::new(bytes),
        }
    }

    pub fn advance(&mut self, amount: usize) -> Result<(), WireError> {
        self.curs.skip(amount)
    }

    pub fn advance_up_to(&mut self, index: usize) {
        match self.advance(index) {
            Ok(_) => (),
            Err(_) => self.curs = VectoredCursor::new(&[]), // advance() isn't guaranteed to advance cursor to end on failure (though it does right now)
        }
    }

    pub fn finalize(&self) -> Result<(), WireError> {
        if !self.is_empty() {
            Err(WireError::ExtraBytes)
        } else {
            Ok(())
        }
    }

    pub fn is_empty(&self) -> bool {
        self.curs.is_empty()
    }

    pub fn peek<T>(&self) -> Result<T, WireError>
    where
        T: VectoredReadable,
    {
        let mut temp_curs = self.curs; // Cheap and easy to just copy cursor and discard
        T::from_vectored::<E>(&mut temp_curs)
    }

    pub fn peek_sized<T>(&self, size: usize) -> Result<&'a T, WireError>
    where
        T: RefVectoredReadable,
    {
        let mut temp_curs = self.curs;
        T::from_vectored_ref::<E>(&mut temp_curs, size)
    }

    pub fn read<T>(&mut self) -> Result<T, WireError>
    where
        T: VectoredReadable,
    {
        T::from_vectored::<E>(&mut self.curs)
    }

    pub fn read_and_finalize<T>(&mut self) -> Result<T, WireError>
    where
        T: VectoredReadable,
    {
        let ret = self.read()?;
        self.finalize()?;
        Ok(ret)
    }

    pub fn read_partial<T, const L: usize>(&mut self) -> Result<T, WireError>
    where
        T: PartVectoredReadable,
    {
        T::from_vectored_part::<L, E>(&mut self.curs)
    }

    pub fn read_remaining<T>(&mut self) -> Result<&'a T, WireError>
    where
        T: RefVectoredReadable,
    {
        self.read_sized(self.curs.remaining())
    }

    pub fn read_sized<T>(&mut self, size: usize) -> Result<&'a T, WireError>
    where
        T: RefVectoredReadable,
    {
        T::from_vectored_ref::<E>(&mut self.curs, size)
    }

    /*
    pub fn read_array<T, const L: usize>(&mut self) -> Result<[T; L], WireError>
    where T: WireReadable {
        let (ret, consumed) = T::array_from_wire(self.wire)?;
        self.advance_up_to(consumed);
        Ok(ret)
    }

    pub fn read_array_and_finalize<T, const L: usize>(&mut self) -> Result<[T; L], WireError>
    where T: WireReadable {
        let ret = self.read_array()?;
        self.finalize()?;
        Ok(ret)
    }
    */
}

// Implementations of RefWireReadable for base types

impl RefWireReadable for [u8] {
    fn from_wire_ref<'a>(curs: &mut WireCursor<'a>, size: usize) -> Result<&'a Self, WireError> {
        curs.get(size)
    }
}

impl RefWireReadable for str {
    fn from_wire_ref<'a>(curs: &mut WireCursor<'a>, size: usize) -> Result<&'a Self, WireError> {
        curs.get(size).and_then(|bytes| {
            str::from_utf8(bytes).or_else(|_| Err(WireError::InvalidData(UTF8_DECODE_ERROR)))
        })
    }
}

macro_rules! derive_wire_readable {
    ($int:ty)=> {
        impl WireReadable for $int {
            fn from_wire<const E: bool>(curs: &mut WireCursor<'_>) -> Result<Self, WireError> {
                if E {
                    Ok(<$int>::from_be_bytes(*curs.get_array::<{ mem::size_of::<$int>() }>()?))
                } else {
                    Ok(<$int>::from_le_bytes(*curs.get_array::<{ mem::size_of::<$int>() }>()?))
                }
            }
        }
    };

    ($i1:ty, $($i2:ty),+) => {
        derive_wire_readable! { $i1 }
        derive_wire_readable! { $($i2),+ }
    };
}

macro_rules! derive_wire_partreadable {
    ($int:ty)=> {
        impl PartWireReadable for $int {
            fn from_wire_part<const L: usize, const E: bool>(curs: &mut WireCursor<'_>) -> Result<Self, WireError> {
                assert!(L < mem::size_of::<$int>()); // TODO: once more powerful const generic expressions are in rust, use them
                let mut res = [0; mem::size_of::<$int>()];
                let bytes = curs.get_array::<L>()?;

                if E {
                    for (i, b) in bytes.iter().rev().enumerate() {
                        res[i] = *b; // Fill first L bytes in reverse order (be -> le)
                    }
                } else {
                    for (i, b) in bytes.iter().enumerate() {
                        res[i] = *b;
                    }
                }

                Ok(<$int>::from_le_bytes(res)) // Most computers are natively little-endian, so this will be a slightly faster transmutate
            }
        }
    };

    ($i1:ty, $($i2:ty),+) => {
        derive_wire_partreadable! { $i1 }
        derive_wire_partreadable! { $($i2),+ }
    };
}

macro_rules! derive_vectored_readable {
    ($int:ty)=> {
        impl VectoredReadable for $int {
            fn from_vectored<const E: bool>(curs: &mut VectoredCursor<'_>) -> Result<Self, WireError> {
                // Try the more efficient try_get_array; fall back to getting byte by byte on failure
                let arr = match curs.try_get_array::<{ mem::size_of::<$int>() }>() {
                    Some(a) => *a,
                    None => {
                        let mut tmp_arr = [0; mem::size_of::<$int>()];
                        for b in tmp_arr.iter_mut() {
                            *b = curs.get_next()?;
                        }

                        tmp_arr
                    },
                };

                if E {
                    Ok(<$int>::from_be_bytes(arr))
                } else {
                    Ok(<$int>::from_le_bytes(arr))
                }
            }
        }
    };

    ($i1:ty, $($i2:ty),+) => {
        derive_vectored_readable! { $i1 }
        derive_vectored_readable! { $($i2),+ }
    };
}

macro_rules! derive_vectored_partreadable {
    ($int:ty)=> {
        impl PartVectoredReadable for $int {
            fn from_vectored_part<const L: usize, const E: bool>(curs: &mut VectoredCursor<'_>) -> Result<Self, WireError> {
                assert!(L < mem::size_of::<$int>()); // TODO: once more powerful const generic expressions are in rust, use them
                let mut res = [0; mem::size_of::<$int>()];

                // Try the more efficient try_get_array; fall back to getting byte by byte on failure
                let bytes = match curs.try_get_array::<L>() {
                    Some(a) => *a,
                    None => {
                        let mut tmp_arr = [0; L];
                        for b in tmp_arr.iter_mut() {
                            *b = curs.get_next()?;
                        }

                        tmp_arr
                    },
                };

                if E {
                    for (i, b) in bytes.iter().rev().enumerate() {
                        res[i] = *b; // Fill first L bytes in reverse order (be -> le)
                    }
                } else {
                    for (i, b) in bytes.iter().enumerate() {
                        res[i] = *b;
                    }
                }

                Ok(<$int>::from_le_bytes(res)) // Most computers are natively little-endian, so this will be a slightly faster transmutate
            }
        }
    };

    ($i1:ty, $($i2:ty),+) => {
        derive_vectored_partreadable! { $i1 }
        derive_vectored_partreadable! { $($i2),+ }
    };
}

derive_wire_readable!(i8, u8, i16, u16, i32, u32, i64, u64, i128, u128, f32, f64, isize, usize);
derive_vectored_readable!(i8, u8, i16, u16, i32, u32, i64, u64, i128, u128, f32, f64, isize, usize);

// No floats or signed integers--their implementations aren't conducive to chopping off bytes at will
derive_wire_partreadable!(u16, u32, u64, u128, usize);
derive_vectored_partreadable!(u16, u32, u64, u128, usize);