Struct conjoiner_engine::Cobs

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

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

Methods

impl<B> Cobs<B> where
    B: SerFlavor + IndexMut<usize, Output = u8>, 

pub fn try_new(bee: B) -> Result<Cobs<B>, Error>

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<'a, B> SerFlavor for Cobs<B> where
    B: SerFlavor + IndexMut<usize, Output = u8>, 

type Output = <B as SerFlavor>::Output

The Output type is what this flavor "resolves" to when the serialization is complete. For storage flavors, this is typically a concrete type. For modification flavors, this is typically a generic parameter for the storage flavor they are wrapped around.

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

The try_push() trait method can be used to push a single byte to be modified and/or stored

fn release(self) -> Result<<Cobs<B> as SerFlavor>::Output, ()>

The release() trait method finalizes the modification or storage operation, and resolved into the type defined by SerFlavor::Output associated type.

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

The try_extend() trait method can be implemented when there is a more efficient way of processing multiple bytes at once, such as copying a slice to the output, rather than iterating over one byte at a time.