le-stream 8.0.0

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

use crate::{FromLeStream, Result};

/// Consumes a stream of bytes with little endianness to crate an object.
pub trait Consume<T> {
    /// Consumes the iterator to create an instance of `T`.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`] if the stream terminates prematurely or contains excess bytes.
    fn consume(self) -> Result<T>;

    /// Consumes the iterator partially to create an instance of `T`.
    fn consume_partial(self) -> Option<T>;
}

impl<T, I> Consume<T> for I
where
    T: FromLeStream,
    I: Iterator<Item = u8>,
{
    fn consume(self) -> Result<T> {
        T::from_le_stream_exact(self)
    }

    fn consume_partial(self) -> Option<T> {
        T::from_le_stream(self)
    }
}