Skip to main content

LongFrame

Struct LongFrame 

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

A variable-format frame containing user data.

Implementations§

Source§

impl LongFrame

Source

pub const START: u8 = 0x68

Initial and repeated start byte.

Source

pub const FIXED_DATA_LEN: usize = 3

Number of checksum-covered bytes before user data.

Source

pub const MIN_USER_DATA_LEN: usize = 1

Minimum user-data length.

Source

pub const MAX_USER_DATA_LEN: usize = 252

Maximum user-data length permitted by the one-byte length field.

Source

pub const STOP: u8 = 0x16

Final frame byte.

Source

pub const MIN_LEN: usize = 10

Minimum encoded frame length.

Source

pub const MAX_LEN: usize = 261

Maximum encoded frame length.

Source

pub fn new( control: Control, address: Address, control_information: u8, user_data: &[u8], ) -> Result<Self, LongFrameError>

Creates a validated long frame and copies user_data into inline storage.

Source

pub const fn control(&self) -> Control

Returns the control field.

Source

pub const fn address(&self) -> Address

Returns the address field.

Source

pub const fn control_information(&self) -> u8

Returns the control-information byte.

Source

pub fn user_data(&self) -> &[u8]

Returns the user-data bytes.

Source

pub fn decode(bytes: &[u8]) -> Result<Self, LongFrameError>

Decodes exactly one long frame.

Source

pub fn encode_into<'a>( &self, output: &'a mut [u8], ) -> Result<&'a [u8], LongFrameError>

Encodes the frame into output and returns the encoded portion.

Source

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

Encodes the frame into a newly allocated vector.

Trait Implementations§

Source§

impl Clone for LongFrame

Source§

fn clone(&self) -> LongFrame

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 LongFrame

Source§

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

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

impl Eq for LongFrame

Source§

impl From<LongFrame> for Frame

Source§

fn from(frame: LongFrame) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for LongFrame

Source§

fn eq(&self, other: &LongFrame) -> 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 LongFrame

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