Enum tokio_modbus::Request

pub enum Request<'a> {
    ReadCoils(Address, Quantity),
    ReadDiscreteInputs(Address, Quantity),
    WriteSingleCoil(Address, bool),
    WriteMultipleCoils(Address, Cow<'a, [bool]>),
    ReadInputRegisters(Address, Quantity),
    ReadHoldingRegisters(Address, Quantity),
    WriteSingleRegister(Address, u16),
    WriteMultipleRegisters(Address, Cow<'a, [u16]>),
    MaskWriteRegister(Address, u16, u16),
    ReadWriteMultipleRegisters(Address, Quantity, Address, Cow<'a, [u16]>),
    Custom(u8, Cow<'a, [u8]>),
    Disconnect,
}

A request represents a message from the client (master) to the server (slave).

Variants

ReadCoils(Address, Quantity)

A request to read multiple coils. The first parameter is the address of the first coil to read. The second parameter is the number of coils to read.

ReadDiscreteInputs(Address, Quantity)

A request to read multiple discrete inputs The first parameter is the address of the first discrete input to read. The second parameter is the number of discrete inputs to read.

WriteSingleCoil(Address, bool)

A request to write a single coil. The first parameter is the address of the coil. The second parameter is the value to write to the coil.

WriteMultipleCoils(Address, Cow<'a, [bool]>)

A request to write multiple coils. The first parameter is the address of the first coil to write. The second parameter is the vector of values to write to the coils.

ReadInputRegisters(Address, Quantity)

A request to read multiple input registers. The first parameter is the address of the first input register to read. The second parameter is the number of input registers to read.

ReadHoldingRegisters(Address, Quantity)

A request to read multiple holding registers. The first parameter is the address of the first holding register to read. The second parameter is the number of holding registers to read.

WriteSingleRegister(Address, u16)

A request to write a single register. The first parameter is the address of the register to read. The second parameter is the value to write to the register.

WriteMultipleRegisters(Address, Cow<'a, [u16]>)

A request to write to multiple registers. The first parameter is the address of the first register to write. The second parameter is the vector of values to write to the registers.

MaskWriteRegister(Address, u16, u16)

A request to set or clear individual bits of a holding register. The first parameter is the address of the holding register. The second parameter is the AND mask. The third parameter is the OR mask.

ReadWriteMultipleRegisters(Address, Quantity, Address, Cow<'a, [u16]>)

A request to simultaneously read multiple registers and write multiple registers. The first parameter is the address of the first register to read. The second parameter is the number of registers to read. The third parameter is the address of the first register to write. The fourth parameter is the vector of values to write to the registers.

Custom(u8, Cow<'a, [u8]>)

A raw Modbus request. The first parameter is the Modbus function code. The second parameter is the raw bytes of the request.

Disconnect

A poison pill for stopping the client service and to release the underlying transport, e.g. for disconnecting from an exclusively used serial port.

This is an ugly workaround, because tokio-proto does not provide other means to gracefully shut down the ClientService. Otherwise the bound transport is never freed as long as the executor is active, even when dropping the Modbus client context.

Implementations

impl<'a> Request<'a>

pub fn into_owned(self) -> Request<'static>

Converts the request into an owned instance with 'static' lifetime.

pub const fn function_code(&self) -> FunctionCode

Get the FunctionCode of the Request.

Trait Implementations

impl<'a> Clone for Request<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Request<'a>

fn eq(&self, other: &Request<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Bytes> for Request<'static>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: Bytes) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Request<'a>> for Bytes

type Error = Error

The type returned in the event of a conversion error.

fn try_from(req: Request<'a>) -> Result<Bytes, Self::Error>

Performs the conversion.

impl<'a> Eq for Request<'a>

impl<'a> StructuralPartialEq for Request<'a>