Struct cobs::EncoderState

pub struct EncoderState { /* private fields */ }

The EncoderState is used to track the current state of a streaming encoder. This struct does not contain the output buffer (or a reference to one), and can be used when streaming the encoded output to a custom data type

IMPORTANT NOTE: When implementing a custom streaming encoder, the EncoderState state machine assumes that the output buffer ALREADY contains a single placeholder byte, and no other bytes. This placeholder byte will be later modified with the first distance to the next header/zero byte.

Implementations

impl EncoderState

pub fn push(&mut self, data: u8) -> PushResult

Push a single unencoded byte into the encoder state machine

pub fn finalize(self) -> (usize, u8)

Finalize the encoding process for a single message. The byte at the given index should be replaced with the given value, and the sentinel value (typically 0u8) must be inserted at the current end of the output buffer, serving as a framing byte.

Trait Implementations

impl Clone for EncoderState

fn clone(&self) -> EncoderState

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EncoderState

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

Formats the value using the given formatter.

impl Default for EncoderState

fn default() -> Self

Create a default initial state representation for a COBS encoder