Struct ModbusFunction

pub struct ModbusFunction(pub u8);

A modbus function. This struct may store public as well as custom functions. The only invalid function is 0.

This structure is a new type wrapper over u8 which adds function code identification methods.

Tuple Fields

0: u8

Implementations

impl ModbusFunction

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

pub const fn new_public(public_function: PublicModbusFunction) -> Self

Create a modbus function from a public Modbus function

pub const fn is(self, public_function: PublicModbusFunction) -> bool

Checks if this function matches the given public function

pub const fn is_valid(self) -> bool

Check if this function code is valid. Only 0 is invalid.

pub const fn is_public(self) -> bool

Checks if this function is a publicly documented modbus function.

This function returns true if this is a public reserved AND publicly documented function specified in the modbus spec

pub const fn is_public_reserved(self) -> bool

Checks if this function is a public reserved function. Any valid and non custom function is reserved.

pub const fn is_custom(self) -> bool

Checks if this function is a custom function code

pub const fn is_exception(self) -> bool

Checks if this function code is an expection code. Which means that self >= 128

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

Gets the function code 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 function code of the given modbus data.

Safety

Providing data with less than one byte is undefined behavior

Trait Implementations

impl Clone for ModbusFunction

fn clone(&self) -> ModbusFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModbusFunction

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

Formats the value using the given formatter.

impl Default for ModbusFunction

fn default() -> ModbusFunction

Returns the “default value” for a type.

impl From<ModbusFunction> for PublicModbusFunction

fn from(mf: ModbusFunction) -> Self

Converts to this type from the input type.

impl From<PublicModbusFunction> for ModbusFunction

fn from(public_function: PublicModbusFunction) -> Self

Converts to this type from the input type.

impl From<u8> for ModbusFunction

fn from(b: u8) -> Self

Converts to this type from the input type.

impl Hash for ModbusFunction

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 ModbusFunction

fn into(self) -> u8

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

impl Ord for ModbusFunction

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

fn eq(&self, other: &ModbusFunction) -> 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 PartialEq<PublicModbusFunction> for ModbusFunction

fn eq(&self, other: &PublicModbusFunction) -> 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 PartialEq for ModbusFunction

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

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

impl Eq for ModbusFunction

impl StructuralPartialEq for ModbusFunction