Skip to main content

Frame

Enum Frame 

Source
pub enum Frame {
    Data {
        frm_num: u8,
        re_tx: bool,
        ack_num: u8,
        payload: Vec<u8>,
    },
    Ack {
        ack_num: u8,
        not_ready: bool,
    },
    Nak {
        ack_num: u8,
        not_ready: bool,
    },
    Rst,
    RstAck {
        version: u8,
        code: u8,
    },
    Error {
        version: u8,
        code: u8,
    },
}
Expand description

One ASH frame.

Variants§

§

Data

Carries one EZSP frame.

Fields

§frm_num: u8

This frame’s number, 0 to 7.

§re_tx: bool

Set when this is a retransmission.

§ack_num: u8

The next frame number the sender expects to receive.

§payload: Vec<u8>

The EZSP frame, already de-randomized.

§

Ack

Acknowledges every frame before ack_num.

Fields

§ack_num: u8

The next frame number expected.

§not_ready: bool

The sender is not ready to receive DATA.

§

Nak

Rejects: the frame ack_num was missing or bad.

Fields

§ack_num: u8

The next frame number expected.

§not_ready: bool

The sender is not ready to receive DATA.

§

Rst

Host to NCP: reset.

§

RstAck

NCP to host: reset done.

Fields

§version: u8

ASH version, 2.

§code: u8

Why the NCP reset (reset_code).

§

Error

NCP to host: fatal error, the NCP is now disconnected.

Fields

§version: u8

ASH version, 2.

§code: u8

The error (reset_code).

Implementations§

Source§

impl Frame

Source

pub fn control(&self) -> u8

The control byte.

Source

pub fn encode(&self) -> Vec<u8> ⓘ

The frame as sent on the wire: stuffed, with its CRC and closing flag. RST is preceded by a cancel byte so it never joins a partial frame.

Source

pub fn parse(raw: &[u8]) -> Result<Frame, FrameError>

Parse an unstuffed frame: control byte, fields and CRC, without the flag.

Trait Implementations§

Source§

impl Clone for Frame

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Frame

Source§

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

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

impl Eq for Frame

Source§

impl PartialEq for Frame

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Frame

Auto Trait Implementations§

§

impl Freeze for Frame

§

impl RefUnwindSafe for Frame

§

impl Send for Frame

§

impl Sync for Frame

§

impl Unpin for Frame

§

impl UnsafeUnpin for Frame

§

impl UnwindSafe for Frame

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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