framez 0.4.0

A zerocopy codec for encoding and decoding data in no_std environments.
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

//! Decoder trait definition.

/// An error that can occur while decoding a frame.
pub trait DecodeError {
    /// The type of error that a decoder returns.
    type Error;
}

impl<D> DecodeError for &mut D
where
    D: DecodeError,
{
    type Error = D::Error;
}

/// A decoder that decodes a frame from a buffer.
pub trait Decoder<'buf>: DecodeError {
    /// The type of item that this decoder decodes.
    type Item;

    /// Decodes a frame from the provided buffer.
    fn decode(&mut self, src: &'buf mut [u8]) -> Result<Option<(Self::Item, usize)>, Self::Error>;

    /// Decodes a frame from the provided buffer at the end of the stream.
    fn decode_eof(
        &mut self,
        src: &'buf mut [u8],
    ) -> Result<Option<(Self::Item, usize)>, Self::Error> {
        self.decode(src)
    }
}

impl<'buf, D> Decoder<'buf> for &mut D
where
    D: Decoder<'buf>,
{
    type Item = D::Item;

    fn decode(&mut self, src: &'buf mut [u8]) -> Result<Option<(Self::Item, usize)>, Self::Error> {
        (*self).decode(src)
    }

    fn decode_eof(
        &mut self,
        src: &'buf mut [u8],
    ) -> Result<Option<(Self::Item, usize)>, Self::Error> {
        (*self).decode_eof(src)
    }
}