Struct mini_slcan::read::CommandBuf

pub struct CommandBuf { /* fields omitted */ }

A byte buffer that yields decoded Commands.

This is meant to be used by apps that receive bytewise data and want to decode Commands from that.

Implementations

impl CommandBuf

pub const fn new() -> Self

Creates a new, empty CommandBuf.

pub fn tail_mut(&mut self) -> &mut [u8]

Returns the currently unused part of the buffer.

The caller can copy new input bytes into the returned slice, and call advance_by to mark them as part of the CommandBuf.

pub fn advance_by(
    &mut self,
    amount: u8
) -> impl Iterator<Item = Result<Command, Error>> + '_

Marks len more bytes from the buffer's tail as consumed, and returns an iterator over all Commands in the buffer.

When dropped, the returned iterator will remove the decoded bytes from the CommandBuf.

Trait Implementations

impl Debug for CommandBuf

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

Formats the value using the given formatter.

impl Default for CommandBuf

fn default() -> CommandBuf

Returns the "default value" for a type.