Struct CobsEncoder

pub struct CobsEncoder<'a> { /* private fields */ }

The CobsEncoder type is used to encode a stream of bytes to a given mutable output slice. This is often useful when heap data structures are not available, or when not all message bytes are received at a single point in time.

Implementations

impl<'a> CobsEncoder<'a>

pub fn new(out_buf: &'a mut [u8]) -> CobsEncoder<'a>

Create a new streaming Cobs Encoder

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

Push a slice of data to be encoded

pub fn finalize(self) -> Result<usize, ()>

Complete encoding of the output message. Does NOT terminate the message with the sentinel value

Trait Implementations

impl<'a> Debug for CobsEncoder<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.