Struct Cobs

pub struct Cobs<B>
where
    B: Flavor + IndexMut<usize, Output = u8>,
{ /* private fields */ }

The Cobs flavor implements Consistent Overhead Byte Stuffing on the serialized data. The output of this flavor includes the termination/sentinel byte of 0x00.

This protocol is useful when sending data over a serial interface without framing such as a UART

Implementations

impl<B> Cobs<B>

where B: Flavor + IndexMut<usize, Output = u8>,

pub fn try_new(bee: B) -> Result<Self>

Create a new Cobs modifier Flavor. If there is insufficient space to push the leading header byte, the method will return an Error

Trait Implementations

impl<B> Flavor for Cobs<B>

where B: Flavor + IndexMut<usize, Output = u8>,

type Output = <B as Flavor>::Output

The Output type is what this storage “resolves” to when the serialization is complete, such as a slice or a Vec of some sort.

fn try_push(&mut self, data: u8) -> Result<()>

Push a single byte to be modified and/or stored.

fn finalize(self) -> Result<Self::Output>

Finalize the serialization process.

fn try_extend(&mut self, data: &[u8]) -> Result<()>

Override this method when you want to customize processing multiple bytes at once, such as copying a slice to the output, rather than iterating over one byte at a time.