Struct rzcobs::Encoder

pub struct Encoder<W> { /* fields omitted */ }

Streaming encoder

Allows encoding of reverse-COBS messages in a streaming fashion, with almost no memory usage (internal state is just one single byte!).

To encode a message, call write for each byte in the message, then call end.

You may use the same Encoder instance to encode multiple messages. In this case, you will probably want to separate messages with a 0x00, which you have to write manually after calling end, for example with encoder.writer().write(0).

Implementations

impl<W> Encoder<W>

pub const fn new(w: W) -> Self

Create a new encoder with the given writer.

pub fn writer(&mut self) -> &mut W

Mutably borrow the inner writer.

impl<W: Write> Encoder<W>

pub fn write(&mut self, byte: u8) -> Result<(), W::Error>

Write a message byte.

pub fn end(&mut self) -> Result<(), W::Error>

Finish encoding a message.

This does NOT write a 0x00 separator byte, you must write it yourself if you so desire.