Struct ReadCoils 

pub struct ReadCoils {
    pub addr: u16,
    pub quantity: u16,
}

The request structure to read Coils

used to parse and build modbus data to read quantity entities starting from addr.

Fields

addr: u16

quantity: u16

Implementations

impl ReadCoils

pub const MODBUS_FUNCTION_CODE: PublicModbusFunction = PublicModbusFunction::ReadCoils

The Modbus function this read requests corresponds to.

pub const fn new(addr: u16, quantity: u16) -> Self

Create a new request to read quantity Coils

pub fn from_data(data: &[u8]) -> Result<(Self, &[u8]), ModbusSerializationError>

Parse this request from the given modbus data

The data should only consist out of the address and quantity as the slave id function will be already read through other means.

pub unsafe fn from_data_unchecked(data: &[u8]) -> (Self, &[u8])

Parse this request from the given modbus data without bounds checks.

The data should only consist out of the address and quantity as the slave id function will be already read through other means.

Safety

This function causes undefined behavior if the len of data is smaller than 4

pub fn into_data(self) -> [u8; 5]

Create modbus data of the correct size from this request

The format of the array will be [addrhi, addrlo, quantityhi, quantitylo] in big endian

pub fn write_to_slice( self, out: &mut [u8], ) -> Result<(), ModbusSerializationError>

Write this request to the slice as modbus data

pub unsafe fn write_to_slice_unchecked(self, out: &mut [u8])

Write this request to the slice as modbus data without bounds checking.

Safety

This function invokes undefined behavior if the len of data is less than 5

Trait Implementations

impl Clone for ReadCoils

fn clone(&self) -> ReadCoils

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadCoils

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

Formats the value using the given formatter.

impl Default for ReadCoils

fn default() -> ReadCoils

Returns the “default value” for a type.

impl Hash for ReadCoils

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ReadCoils

fn cmp(&self, other: &ReadCoils) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ReadCoils

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

fn partial_cmp(&self, other: &ReadCoils) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ReadCoils

impl Eq for ReadCoils

impl StructuralPartialEq for ReadCoils