Struct ClientOptions 

pub struct ClientOptions { /* private fields */ }

Common options for all Modbus clients — timeout, WireTap, reconnect, timing.

Examples

use oms_modbus::*;
use std::time::Duration;

let opts = ClientOptions::default()
    .with_timeout(Duration::from_secs(3))
    .with_tap(std::sync::Arc::new(BusCapture::unbounded()))
    .with_reconnect(3, Duration::from_millis(100));

let client = rtu::with_options(port, opts);

Implementations

impl ClientOptions

pub fn new() -> Self

Create a new ClientOptions with default values (1s timeout, 3.5T @ 9600 baud).

pub fn timeout(&self) -> Duration

Current request timeout.

pub fn reconnect(&self) -> Option<&ReconnectConfig>

Configured reconnect parameters, if any.

pub fn bus_timing(&self) -> Option<&Arc<BusTiming>>

Configured bus timing, if any.

pub fn tap(&self) -> Option<&Arc<dyn WireTap>>

Attached WireTap, if any.

pub fn with_timeout(self, timeout: Duration) -> Self

Set the per-request timeout. Applied to both send and receive.

pub fn with_tap(self, tap: Arc<dyn WireTap>) -> Self

Attach any WireTap — BusCapture, FileRecorder, or custom.

pub fn with_reconnect(self, max_retries: u32, interval: Duration) -> Self

Enable auto-reconnect on transport errors with a fixed retry interval. max_retries = 0 means infinite.

pub fn with_bus_timing(self, timing: BusTiming) -> Self

Enforce minimum spacing between Modbus frames.

Prevents sending too fast on RS-485 buses where low-performance slave devices may crash. Use BusTiming::rtu_35t for standard RTU/ASCII timing, or BusTiming::custom for a fixed delay.

pub fn with_data_channel_capacity(self, bytes: usize) -> Self

Set the SniffIo data channel capacity in bytes (default: 1 MB).

Only meaningful when a tap is attached. The data channel buffers bytes between the background reader and poll_read. When full, oldest chunks are evicted.

pub fn with_tap_channel_capacity(self, bytes: usize) -> Self

Set the SniffIo tap channel capacity in bytes (default: 256 KB).

Only meaningful when a tap is attached. The tap channel buffers bytes for the tap forwarder task. When full, oldest chunks are evicted.

Trait Implementations

impl Clone for ClientOptions

fn clone(&self) -> ClientOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ClientOptions

fn default() -> Self

Returns the “default value” for a type.