Struct RtuCodec 

pub struct RtuCodec { /* private fields */ }

Modbus RTU codec.

This codec handles the encoding and decoding of RTU frames with proper timing-based frame detection.

Example

use mabi_modbus::rtu::{RtuCodec, RtuTiming};
use tokio_util::codec::Framed;

// Create codec with default timing (9600 baud)
let codec = RtuCodec::new();

// Create codec with custom timing
let codec = RtuCodec::with_timing(RtuTiming::from_baud_rate(115200));

Implementations

impl RtuCodec

pub fn new() -> Self

Create a new RTU codec with default timing (9600 baud).

pub fn with_timing(timing: RtuTiming) -> Self

Create a codec with specific timing configuration.

pub fn with_baud_rate(baud_rate: u32) -> Self

Create a codec for a specific baud rate.

pub fn strict_timing(self, enabled: bool) -> Self

Enable strict timing-based frame detection.

pub fn unit_id_filter(self, unit_ids: Vec<u8>) -> Self

Set unit ID filter.

Only frames with matching unit IDs will be accepted.

pub fn timing(&self) -> &RtuTiming

Get the timing configuration.

pub fn reset(&mut self)

Reset the codec state.

Trait Implementations

impl Debug for RtuCodec

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

Formats the value using the given formatter.

impl Decoder for RtuCodec

type Item = RtuFrame

The type of decoded frames.

type Error = ModbusError

The type of unrecoverable frame decoding errors.

fn decode( &mut self, src: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

Attempts to decode a frame from the provided buffer of bytes.

fn decode_eof( &mut self, buf: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T>(self, io: T) -> Framed<T, Self>

where T: AsyncRead + AsyncWrite, Self: Sized,

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

impl Default for RtuCodec

fn default() -> Self

Returns the “default value” for a type.

impl Encoder<RtuFrame> for RtuCodec

type Error = ModbusError

The type of encoding errors.

fn encode( &mut self, item: RtuFrame, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.