Skip to main content

CommandKeyParser

Struct CommandKeyParser 

Source
pub struct CommandKeyParser { /* private fields */ }
Expand description

State machine that splits stdin bytes into “data to send” vs. “commands to dispatch” using the configurable escape key.

Implementations§

Source§

impl CommandKeyParser

Source

pub const fn new(escape: u8) -> Self

Builds a parser whose command key is escape (commonly ^T = 0x14).

Source

pub const fn escape_byte(&self) -> u8

Returns the escape byte this parser was configured with.

Source

pub fn feed(&mut self, byte: u8) -> ParseOutput

Feed a single input byte; returns whatever the parser decided to emit for it.

State transitions (with ^T as the escape byte for illustration):

from \ byte^TEsc (0x1b)mapped commandbdigit (in baud sub-state)\r / \n (in baud sub-state)other
Default→ AwaitingCommand→ Data(byte)→ Data(byte)→ Data(byte)n/an/a→ Data(byte)
AwaitingCommand→ Data(^T)→ Default→ Command(…)→ AwaitingBaudDigitsn/an/a→ Default (drop)
AwaitingBaudDigits→ Default (drop)→ Default→ Default (drop)→ Default (drop)append, stay→ SetBaud / Default→ Default (drop)

Trait Implementations§

Source§

impl Default for CommandKeyParser

Source§

fn default() -> Self

Creates a parser whose escape byte is DEFAULT_ESCAPE_BYTE (^A / 0x01).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more