Enum FunctionKind 

#[repr(u8)]
pub enum FunctionKind {
    ReadCoils = 1,
    ReadDiscreteInputs = 2,
    ReadHoldingRegisters = 3,
    ReadInputRegisters = 4,
    WriteSingleCoil = 5,
    WriteSingleRegister = 6,
    WriteMultipleCoils = 15,
    WriteMultipleRegisters = 16,
}

FunctionKind

FunctionKind represents the function codes defined by the Modbus RTU standard protocol. Functions not listed here are not supported.

Variants

ReadCoils = 1

Read Coils (0x01)

ReadDiscreteInputs = 2

Read Discrete Inputs (0x02)

ReadHoldingRegisters = 3

Read Holding Registers (0x03)

ReadInputRegisters = 4

Read Input Registers (0x04)

WriteSingleCoil = 5

Write Single Coil (0x05)

WriteSingleRegister = 6

Write Single Register (0x06)

WriteMultipleCoils = 15

Write Multiple Coils (0x0F)

WriteMultipleRegisters = 16

Write Multiple Registers (0x10)

Implementations

impl FunctionKind

pub const fn as_code(&self) -> u8

Returns the Modbus RTU function code represented by this FunctionKind.

---

Examples

use modbus_rtu::FunctionKind;

let code = FunctionKind::ReadHoldingRegisters.as_code();
assert_eq!(code, 0x03);

pub fn from_code(code: u8) -> Option<Self>

Converts a Modbus RTU function code into its FunctionKind counterpart.

Returns Some when the code is supported by this crate; otherwise returns None.

---

Examples

use modbus_rtu::FunctionKind;

let kind = FunctionKind::from_code(0x04);
assert_eq!(kind, Some(FunctionKind::ReadInputRegisters));

let unsupported = FunctionKind::from_code(0x7F);
assert_eq!(unsupported, None);

Trait Implementations

impl Clone for FunctionKind

fn clone(&self) -> FunctionKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionKind

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

Formats the value using the given formatter.

impl Display for FunctionKind

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

Formats the value using the given formatter.

impl PartialEq for FunctionKind

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

impl Eq for FunctionKind

impl StructuralPartialEq for FunctionKind