Skip to main content

ModbusSimulator

Struct ModbusSimulator 

Source
pub struct ModbusSimulator { /* private fields */ }
Expand description

Device simulator wrapping a ModbusServer with preconfigured register maps.

Implementations§

Source§

impl ModbusSimulator

Source

pub fn from_yaml(yaml: &str) -> Result<Self, SimError>

Create a simulator from a YAML configuration string.

§Errors

Returns SimError::ConfigParse if the YAML is invalid, or SimError::Config if any configured block is out of range.

Source

pub fn from_config(config: SimConfig) -> Result<Self, SimError>

Create a simulator from a programmatic configuration.

§Errors

Returns SimError::Config if any configured block exceeds the Modbus 16-bit address space.

Source

pub async fn start(&mut self) -> Result<SocketAddr, SimError>

Start the simulator server. Returns the bound address.

§Errors

Returns SimError::Server if the server fails to start.

Source

pub async fn stop(&mut self)

Stop the simulator server.

Source

pub fn set_holding_register( &self, address: u16, value: u16, ) -> Result<(), SimError>

Update a holding register at runtime.

Source

pub fn set_input_register( &self, address: u16, value: u16, ) -> Result<(), SimError>

Update an input register at runtime.

Source

pub fn set_coil(&self, address: u16, value: bool) -> Result<(), SimError>

Update a coil at runtime.

Source

pub fn local_addr(&self) -> SocketAddr

Get the bound address (only valid after start()).

§Panics

Panics if the server hasn’t been started.

Trait Implementations§

Source§

impl Debug for ModbusSimulator

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more