FrameHeader

Struct FrameHeader 

Source
pub struct FrameHeader {
    pub msg_length: u16,
    pub crc16: u16,
}
Expand description

Wraps a complete RPC (Header + data) on stream transports, like a UART.

Fields§

§msg_length: u16§crc16: u16

Implementations§

Source§

impl FrameHeader

Source

pub fn new_from_msg(msg: &[u8]) -> Self

Builds a frame header which will wrap the provided msg.

Source

pub fn as_bytes(&self) -> [u8; 4]

Encodes the frame header in its wire format.

Source

pub fn parse<I, E: ParseError<I>>(i: I) -> IResult<I, Self, E>
where I: Input<Item = u8>,

Nom parser which decodes a leading FrameHeader from the input. Can be chained with other nom parsers.

Source

pub fn check_crc<I, E>(&self, data: I) -> Result<(), Err<E>>
where I: Input<Item = u8>,

Checks the CRC matches that computed from the provided payload.

Trait Implementations§

Source§

impl Clone for FrameHeader

Source§

fn clone(&self) -> FrameHeader

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FrameHeader

Source§

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

Formats the value using the given formatter. Read more

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

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> Same for T

Source§

type Output = T

Should always be Self
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 = 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.