le-stream 10.1.4

De-/serialize objects from/to little endian byte streams
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

use core::marker::PhantomData;

use crate::FromLeStream;

/// Extension trait for reading typed values from an iterator of bytes.
pub trait LeStream: Sized {
    /// Converts an iterator of little-endian bytes into an iterator of `T`.
    ///
    /// Iteration stops when `T::from_le_stream` returns [`None`], usually
    /// because the underlying byte iterator is exhausted or ends with an
    /// incomplete value.
    fn le_stream<T>(self) -> LeStreamIterator<T, Self>;
}

impl<I> LeStream for I
where
    I: Iterator<Item = u8>,
{
    fn le_stream<T>(self) -> LeStreamIterator<T, Self> {
        LeStreamIterator {
            iterator: self,
            _type: PhantomData,
        }
    }
}

/// Iterator adapter returned by [`LeStream::le_stream`].
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct LeStreamIterator<T, I> {
    iterator: I,
    _type: PhantomData<T>,
}

impl<T, I> LeStreamIterator<T, I> {
    /// Consumes the adapter and returns the underlying byte iterator.
    #[must_use]
    pub fn into_inner(self) -> I {
        self.iterator
    }
}

impl<T, I> Iterator for LeStreamIterator<T, I>
where
    T: FromLeStream,
    I: Iterator<Item = u8>,
{
    type Item = T;

    fn next(&mut self) -> Option<Self::Item> {
        T::from_le_stream(&mut self.iterator)
    }
}