Assembler

Struct Assembler 

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

Assembles bytes from a UART into complete sentences.

Resynchronizing is the normal case, not the exceptional one: a receiver powering up mid-sentence, a UART overrun, and a line longer than MAX_SENTENCE all leave the assembler mid-line, and all of them recover at the next $ without any caller involvement.

Implementations§

Source§

impl Assembler

Source

pub const fn new() -> Self

A fresh assembler, waiting for the first $.

Source

pub fn reset(&mut self)

Discard any partial line. Call after powering the receiver, so bytes from before the power cycle cannot join a sentence from after it.

Source

pub fn push(&mut self, byte: u8) -> Option<Sentence>

Feed one byte, yielding a parsed sentence when one completes.

Returns None for every byte that does not finish a valid sentence — including ones that finish an invalid one, since a bad checksum and an unrecognized sentence are both simply nothing to report.

Trait Implementations§

Source§

impl Default for Assembler

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.