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

use crate::{FromLeStream, Result};

/// Convenience trait for decoding a value from a byte iterator.
pub trait Consume<T> {
    /// Consumes the complete iterator to decode a value of `T`.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`](crate::Error) if the stream terminates prematurely
    /// or contains excess bytes after the decoded value.
    fn consume(self) -> Result<T>;

    /// Decodes one value from the iterator and allows trailing bytes.
    ///
    /// Returns [`None`] when the iterator does not contain enough bytes for a
    /// complete value.
    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)
    }
}