PortStates

Struct PortStates 

Source
pub struct PortStates(/* private fields */);
Expand description

Represents the collective states of all NUMBER_OF_PORTS ports.

This struct holds an array of PortState and provides constants for reading all port states using a single Modbus “Read Holding Registers” (0x03) command.

Implementations§

Source§

impl PortStates

Source

pub const ADDRESS: u16 = 1u16

The Modbus function code 0x03 (Read Holding Registers) register address used for reading all port states sequentially.

Source

pub const QUANTITY: u16 = 8u16

The number of consecutive Modbus registers (Words) to read to get all port states.

This corresponds to NUMBER_OF_PORTS.

Source

pub fn decode_from_holding_registers(words: &[Word]) -> Self

Decodes the states of all ports from a slice of Modbus holding register values.

Expects words to contain NUMBER_OF_PORTS values. Each word in the slice corresponds to the state of a single port, decoded via PortState::decode_from_holding_registers.

If words contains fewer than NUMBER_OF_PORTS items, the remaining port states in the returned struct will retain their default initialized value (PortState::Close). Extra items in words beyond NUMBER_OF_PORTS are ignored.

§Arguments
  • words: A slice of Word containing the register values read from the device.
§Returns

A PortStates struct containing the decoded state for each port.

This function is robust against malformed data:

§Example
// Example data mimicking a Modbus read response for 8 registers
let modbus_data: [Word; NUMBER_OF_PORTS] = [0x1, 0x0, 0xFFFF, 0x0, 0x0, 0x0, 0x1234, 0x0];
let decoded_states = PortStates::decode_from_holding_registers(&modbus_data);
assert_eq!(decoded_states.as_array()[0], PortState::Open);
assert_eq!(decoded_states.as_array()[1], PortState::Close);
assert_eq!(decoded_states.as_array()[2], PortState::Open); // Non-zero treated as Open
// ... and so on for all ports
Source

pub fn iter(&self) -> Iter<'_, PortState>

Returns an iterator over the individual PortState values in the order of the ports.

Source

pub fn as_slice(&self) -> &[PortState]

Returns a slice containing all Temperature values.

Source

pub fn as_array(&self) -> &[PortState; 8]

Provides direct access to the underlying array of port states.

Trait Implementations§

Source§

impl Clone for PortStates

Source§

fn clone(&self) -> PortStates

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 PortStates

Source§

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

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

impl<'de> Deserialize<'de> for PortStates

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for PortStates

Provides a comma-separated string representation of all port states (e.g., “close, open, close, …”).

Source§

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

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

impl Hash for PortStates

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Index<usize> for PortStates

Source§

fn index(&self, index: usize) -> &Self::Output

Allows indexing into the port states array.

§Panics

Panics if the index is out of bounds (0-7).

Source§

type Output = PortState

The returned type after indexing.
Source§

impl<'a> IntoIterator for &'a PortStates

Source§

type Item = &'a PortState

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, PortState>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl IntoIterator for PortStates

Source§

type Item = PortState

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<PortState, NUMBER_OF_PORTS>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl PartialEq for PortStates

Source§

fn eq(&self, other: &PortStates) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for PortStates

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for PortStates

Source§

impl Eq for PortStates

Source§

impl StructuralPartialEq for PortStates

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,