Struct SlaveId 

pub struct SlaveId(/* private fields */);

A u8 wrapper type to represent slave ids

Implementations

impl SlaveId

pub const fn new(id: u8) -> Self

pub const fn new_default_tcp() -> Self

The default TCP slave id is 255 decimal or 0xFF hex.

Addressing in TCP is normally done through the ip address so the slave id just set to 0xFF. In many cases this rule is ignored and a certain slave address is expected. See https://modbus.org/docs/Modbus_Messaging_Implementation_Guide_V1_0b.pdf espacially page 23 for more details.

pub const fn new_broadcast() -> Self

Creates a new broadcast slave id. The broadcast id is 0 and every slave device MUST react to it.

pub const fn is_device(self) -> bool

Check if this id is for a normal device. Only false if this is a reserved function code (> 248) or broadcast (0)

pub const fn is_reserved(self) -> bool

Checks if this function is any reserved slave address other than broadcast. (id > 248)

pub const fn is_broadcast(self) -> bool

Checks if this is a broadcast slave id. The broadcast id is 0 and every slave device MUST react to it.

pub const fn is_default_tcp(self) -> bool

Checks if this is the default TCP slave id (0xFF)

pub const fn must_react(self, other: SlaveId) -> bool

Checks if a device with this slave id has to react to the given slave id other

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

Gets the slave id of the given modbus data.

None is returned if data contains less than 1 byte

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

Gets the slave id of the given modbus data.

Safety

Providing data with less than one byte is undefined behavior

Trait Implementations

impl Clone for SlaveId

fn clone(&self) -> SlaveId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SlaveId

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

Formats the value using the given formatter.

impl Default for SlaveId

fn default() -> SlaveId

Returns the “default value” for a type.

impl From<u8> for SlaveId

fn from(sid: u8) -> Self

Converts to this type from the input type.

impl Hash for SlaveId

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 Into<u8> for SlaveId

fn into(self) -> u8

Converts this type into the (usually inferred) input type.

impl Ord for SlaveId

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

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

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

impl Eq for SlaveId

impl StructuralPartialEq for SlaveId