EscapeWatcher

Struct EscapeWatcher 

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

Observes inbound CDC bytes for the rescue prefix Ctrl-C Ctrl-C Ctrl-C dfu followed by \r or \n. On match, returns RescueAction::TriggerDfu so the caller can put the device into serial DFU mode independent of the CLI session.

The watcher is non-consuming: callers should hand each received byte to EscapeWatcher::observe before passing it to the CLI parser, not instead of. This preserves Ctrl-C’s “abort” semantics inside the CLI.

Implementations§

Source§

impl EscapeWatcher

Source

pub const fn new() -> Self

Source

pub fn observe(&mut self, byte: u8) -> RescueAction

Feed one received byte. Returns TriggerDfu exactly once on completion of the magic sequence; further bytes return None until reset is called.

Source

pub fn observe_slice(&mut self, bytes: &[u8]) -> RescueAction

Convenience: observe every byte in a slice.

Source

pub fn fired(&self) -> bool

Source

pub fn reset(&mut self)

Trait Implementations§

Source§

impl Debug for EscapeWatcher

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EscapeWatcher

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.