Struct Decoder

pub struct Decoder<B: Buffer> { /* private fields */ }

Decoder for sml transport v1.

Examples

let bytes = [0x1b, 0x1b, 0x1b, 0x1b, 0x01, 0x01, 0x01, 0x01, 0x12, 0x34, 0x56, 0x78, 0x1b, 0x1b, 0x1b, 0x1b, 0x1a, 0x00, 0xb8, 0x7b];
let expected = [0x12, 0x34, 0x56, 0x78];

let mut decoder = Decoder::<ArrayBuf<20>>::new();
for b in bytes {
    match decoder.push_byte(b) {
        Ok(None) => {},  // nothing to output currently
        Ok(Some(decoded)) => {  // complete and valid message was decoded
            assert_eq!(decoded, expected);
        }
        Err(e) => {
            panic!("Unexpected Error: {:?}", e);
        }
    }
}
assert_eq!(decoder.finalize(), None)

Implementations

impl<B: Buffer> Decoder<B>

pub fn new() -> Self

Constructs a new decoder.

pub fn from_buf(buf: B) -> Self

Constructs a new decoder using an existing buffer buf.

pub fn push_byte(&mut self, b: u8) -> Result<Option<&[u8]>, DecodeErr>

Pushes a byte b into the decoder, advances the parser state and possibly returns a transmission or an decoder error.

pub fn finalize(&mut self) -> Option<DecodeErr>

Resets the Decoder and returns an error if it contained an incomplete message.

pub fn reset(&mut self) -> usize

Resets the Decoder and returns the number of bytes that were discarded

Trait Implementations

impl<B: Buffer> Default for Decoder<B>

fn default() -> Self

Returns the “default value” for a type.