Skip to main content

FrameView

Struct FrameView 

Source
pub struct FrameView<'a> { /* private fields */ }
Expand description

A frame with an unknown PDU type.

let frame = FrameView::try_from_bytes(&hex!("01 06 00 04 00 02 49 CA")).unwrap();

assert_eq!(frame.unit_id(), 1);
assert!(frame.validate_crc().is_ok());

Implementations§

Source§

impl<'a> FrameView<'a>

Source

pub fn try_from_bytes(buf: &'a [u8]) -> Option<Self>

Parse a frame from a byte slice. This method does not validate the CRC or the PDU contents, only that the frame has a valid length.

Source

pub const fn unit_id(&self) -> u8

The unit ID of the frame.

Source

pub const fn crc(&self) -> u16

The CRC sent with the frame. This struct does not guarantee that the CRC is valid; be sure to check it with FrameView::validate_crc.

Source

pub fn pdu(self) -> Result<&'a PduView, CrcError>

Returns the wrapped PDU if the CRC is valid.

Source

pub fn validate_crc(&self) -> Result<(), CrcError>

Validate the CRC of the frame.

Note that FrameView::pdu validates the CRC before returning the PDU, rendering this method unnecessary to call directly in most cases.

Auto Trait Implementations§

§

impl<'a> Freeze for FrameView<'a>

§

impl<'a> RefUnwindSafe for FrameView<'a>

§

impl<'a> Send for FrameView<'a>

§

impl<'a> Sync for FrameView<'a>

§

impl<'a> Unpin for FrameView<'a>

§

impl<'a> UnsafeUnpin for FrameView<'a>

§

impl<'a> UnwindSafe for FrameView<'a>

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