Struct Frame 

pub struct Frame<T> { /* private fields */ }

A complete Modbus frame.

Implementations

impl<T> Frame<T>

pub fn new(unit_id: u8, pdu: T) -> Self

where T: Pdu,

Creates a new frame with the given unit ID and PDU and calculates the CRC.

pub const fn builder(unit_id: u8) -> FrameBuilder<T>

where T: Pdu,

Creates a new FrameBuilder.

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

where T: IntoBytes + Unaligned + Immutable,

Validates the CRC of the frame. Self::into_data will also validate the CRC, so in most cases you should not need to call this method directly.

pub fn unit_id(&self) -> u8

Returns the unit ID of the frame.

pub fn pdu(&self) -> &T

Returns a reference to the PDU of the frame.

pub fn into_data<Request>( self, request: &Frame<Request>, ) -> Result<T::Data, ValidationError>

where T: Response<Request>,

Validate the frame against the given request, returning the data if valid.

pub fn view(&self) -> FrameView<'_>

where T: IntoBytes + Unaligned + Immutable,

Upcast the frame to an FrameView.

Trait Implementations

impl<T: Clone> Clone for Frame<T>

fn clone(&self) -> Frame<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Frame<T>

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

Formats the value using the given formatter.

impl<T> FromBytes for Frame<T>

where u8: FromBytes, T: FromBytes, U16: FromBytes,

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

impl<T> FromZeros for Frame<T>

where u8: FromZeros, T: FromZeros, U16: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl<T> IntoBytes for Frame<T>

where u8: IntoBytes + Unaligned, T: IntoBytes + Unaligned, U16: IntoBytes + Unaligned,

fn as_bytes(&self) -> &[u8]

where Self: Immutable,

Gets the bytes of this value.

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

impl<T: PartialEq> PartialEq for Frame<T>

fn eq(&self, other: &Frame<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> TryFromBytes for Frame<T>

where u8: TryFromBytes, T: TryFromBytes, U16: TryFromBytes,

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

impl<T: Copy> Copy for Frame<T>

impl<T: Eq> Eq for Frame<T>

impl<T> Immutable for Frame<T>

where u8: Immutable, T: Immutable, U16: Immutable,

impl<T> StructuralPartialEq for Frame<T>

impl<T> Unaligned for Frame<T>

where u8: Unaligned, T: Unaligned, U16: Unaligned,