Enum RequestForm

pub enum RequestForm<'a> {
    ReadHoldingRegisters {
        start_register: u16,
        registers_count: u16,
    },
    ReadInputRegisters {
        start_register: u16,
        registers_count: u16,
    },
    WriteSingleRegister {
        register_address: u16,
        data_to_write: u16,
    },
    WriteMultipleRegisters {
        start_register: u16,
        data_to_write: &'a [u16],
    },
    BypassRequest(&'a BypassRequest<'a>),
}

Modbus RTU request packet format

Variants

ReadHoldingRegisters

Request format for reading multiple Holding Registers

• start_register: The starting register address
• registers_count: The number of registers to read

Fields

start_register: u16

registers_count: u16

ReadInputRegisters

Request format for reading multiple Input Registers

• start_register: The starting register address
• registers_count: The number of registers to read

Fields

start_register: u16

registers_count: u16

WriteSingleRegister

Request format for writing a single Holding Register

• register_address: The register address to write to
• data_to_write: The data value to write

Fields

register_address: u16

data_to_write: u16

WriteMultipleRegisters

Request format for writing multiple Holding Registers

• start_register: The starting register address
• data_to_wirte: Slice of data values to write to consecutive registers

Fields

start_register: u16

data_to_write: &'a [u16]

BypassRequest(&'a BypassRequest<'a>)

Request format for bypassing a packet to a downstream device

Implementations

impl<'a> RequestForm<'a>

pub fn get_function_code(&self) -> u8

Retrieves the Modbus function code corresponding to the request form variant.

---

Returns

A u8 representing the Modbus function code of the request.

---

Examples

use modbus_rtu::common::RequestForm;

let form = RequestForm::ReadHoldingRegisters {
    start_register: 0x0000,
    registers_count: 2,
};

assert_eq!(form.get_function_code(), 0x03);

Trait Implementations

impl<'a> Clone for RequestForm<'a>

fn clone(&self) -> RequestForm<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RequestForm<'a>

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

Formats the value using the given formatter.