Enum PublicModbusFunction

#[repr(u8)]
pub enum PublicModbusFunction {
    Invalid = 0,
    ReadCoils = 1,
    ReadDiscreteInputs = 2,
    ReadHoldingRegisters = 3,
    ReadInputRegisters = 4,
    WriteSingleCoil = 5,
    WriteSingleRegister = 6,
    ReadExceptionStatus = 7,
    Diagnostics = 8,
    GetCommEventCounter = 11,
    GetCommEventLog = 12,
    WriteMultipleCoils = 15,
    WriteMultipleregisters = 16,
    ReportServerID = 17,
    ReadFileRecord = 20,
    WriteFileRecord = 21,
    MaskWriteRegister = 22,
    ReadWriteMultipleRegisters = 23,
    ReadFIFOQueue = 24,
    EncapsulatedInterfaceTransport = 43,
}

An enum mapping all publicly documented modbus function codes

Invalid is defined as 0, any undocumented or any custom function code. All publicly documented function codes are specified here https://www.modbus.org/docs/Modbus_Application_Protocol_V1_1b3.pdf

Variants

Invalid = 0

ReadCoils = 1

ReadDiscreteInputs = 2

ReadHoldingRegisters = 3

ReadInputRegisters = 4

WriteSingleCoil = 5

WriteSingleRegister = 6

ReadExceptionStatus = 7

Diagnostics = 8

GetCommEventCounter = 11

GetCommEventLog = 12

WriteMultipleCoils = 15

WriteMultipleregisters = 16

ReportServerID = 17

ReadFileRecord = 20

WriteFileRecord = 21

MaskWriteRegister = 22

ReadWriteMultipleRegisters = 23

ReadFIFOQueue = 24

EncapsulatedInterfaceTransport = 43

Implementations

impl PublicModbusFunction

pub const fn is_public_function(code: u8) -> bool

Check if the given code is a publicly documented and valid function code

impl PublicModbusFunction

pub fn new(code: u8) -> Self

Create a PublicModbusFunction from a single byte. Every no public function code returns PublicModbusFunction::Invalid

pub unsafe fn new_unchecked(code: u8) -> Self

Transmutes a ModbusFunction from a byte

Safety

Providing a code where is_public_function code invokes undefined behavior

Trait Implementations

impl Clone for PublicModbusFunction

fn clone(&self) -> PublicModbusFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PublicModbusFunction

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

Formats the value using the given formatter.

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 PublicModbusFunction

fn from(code: u8) -> Self

Converts to this type from the input type.

impl Hash for PublicModbusFunction

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 PublicModbusFunction

fn into(self) -> u8

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

impl Ord for PublicModbusFunction

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

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 PartialOrd for PublicModbusFunction

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

impl Eq for PublicModbusFunction

impl StructuralPartialEq for PublicModbusFunction