1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
//! A set of objects which automatically change their register or coil value when they go out of scope
//!
//! # Examples
//!
//! When the `auto` object goes out of scope and is dropped, the value of coil `10` is switched `On`:
//!
//! ```
//! # extern crate modbus;
//! # extern crate test_server;
//! # use test_server::start_dummy_server;
//! # fn main() {
//! use modbus::{Client, Coil};
//! use modbus::tcp;
//! use modbus::scoped::{ScopedCoil, CoilDropFunction};
//! # if cfg!(feature = "modbus-server-tests") {
//! # let (_s, port) = start_dummy_server(Some(22222));
//!
//! let mut cfg = tcp::Config::default();
//! # cfg.tcp_port = port;
//! let mut client = tcp::Transport::new_with_cfg("127.0.0.1", cfg).unwrap();
//! {
//! let mut auto = ScopedCoil::new(&mut client, 10, CoilDropFunction::On).unwrap();
//! assert_eq!(auto.mut_transport().read_coils(10, 1).unwrap(), vec![Coil::Off]);
//! }
//! assert_eq!(client.read_coils(10, 1).unwrap(), vec![Coil::On]);
//! # }
//! # }
//! ```
//!
//! When the `auto` object goes out of scope and is dropped, the value of register `10` is modified by
//! function `fun`:
//!
//! ```
//! # extern crate modbus;
//! # extern crate test_server;
//! # use test_server::start_dummy_server;
//! # fn main() {
//! use modbus::{Client, Coil};
//! use modbus::tcp;
//! use modbus::scoped::{ScopedRegister, RegisterDropFunction};
//! # if cfg!(feature = "modbus-server-tests") {
//! # let (_s, port) = start_dummy_server(Some(22223));
//!
//! let mut cfg = tcp::Config::default();
//! # cfg.tcp_port = port;
//! let mut client = tcp::Transport::new_with_cfg("127.0.0.1", cfg).unwrap();
//! client.write_single_register(10, 1);
//! {
//! let fun = |v| v + 5;
//! let mut auto = ScopedRegister::new(&mut client, 10, RegisterDropFunction::Fun(&fun)).unwrap();
//! assert_eq!(auto.mut_transport().read_holding_registers(10, 1).unwrap(), vec![1]);
//! }
//! assert_eq!(client.read_holding_registers(10, 1).unwrap(), vec![6]);
//! # }
//! # }
//! ```
use {Client, Coil, Result, Transport};
/// Action to perform when the `ScopedCoil` is dropped.
pub enum CoilDropFunction {
/// Set the coil to `Coil::On`
On,
/// Set the coil to `Coil::Off`
Off,
/// Toggle the current value.
Toggle,
}
/// Action to perform when the `ScopedRegister` is dropped.
pub enum RegisterDropFunction<'a> {
/// Set the register to zero value
Zero,
/// Increment the current register value by 1
Increment,
/// Decrement the current register value by 1
Decrement,
/// Set the register value to the given value.
Value(u16),
/// Execute the given function on the current value, setting the register with the result value.
Fun(&'a dyn Fn(u16) -> u16),
}
/// Auto object which modifies it's coil value depending on a given modification function if it
/// goes out of scope.
pub struct ScopedCoil<'a> {
address: u16,
fun: CoilDropFunction,
transport: &'a mut Transport,
}
impl<'a> Drop for ScopedCoil<'a> {
fn drop(&mut self) {
let _ = self.transport.read_coils(self.address, 1).map(|value| {
if value.len() == 1 {
let drop_value = match self.fun {
CoilDropFunction::On => Coil::On,
CoilDropFunction::Off => Coil::Off,
CoilDropFunction::Toggle => match value[0] {
Coil::On => Coil::Off,
Coil::Off => Coil::On,
},
};
let _ = self.transport.write_single_coil(self.address, drop_value);
}
});
}
}
impl<'a> ScopedCoil<'a> {
/// Create a new `ScopedCoil` object with `address` and drop function when the object goes
/// out of scope.
pub fn new(
transport: &mut Transport,
address: u16,
fun: CoilDropFunction,
) -> Result<ScopedCoil> {
Ok(ScopedCoil {
address,
fun,
transport,
})
}
pub fn mut_transport(&mut self) -> &mut Transport {
self.transport
}
}
/// Auto object which modifies it's register value depending on a given modification function if it
/// goes out of scope.
pub struct ScopedRegister<'a> {
address: u16,
fun: RegisterDropFunction<'a>,
transport: &'a mut Transport,
}
impl<'a> Drop for ScopedRegister<'a> {
fn drop(&mut self) {
let _ = self
.transport
.read_holding_registers(self.address, 1)
.map(|value| {
if value.len() == 1 {
let drop_value = match self.fun {
RegisterDropFunction::Zero => 0u16,
RegisterDropFunction::Increment => value[0] + 1,
RegisterDropFunction::Decrement => value[0] - 1,
RegisterDropFunction::Value(v) => v,
RegisterDropFunction::Fun(f) => f(value[0]),
};
let _ = self
.transport
.write_single_register(self.address, drop_value);
}
});
}
}
impl<'a> ScopedRegister<'a> {
/// Create a new `ScopedRegister` object with `address` and drop function when the object goes
/// out of scope.
pub fn new<'b>(
transport: &'b mut Transport,
address: u16,
fun: RegisterDropFunction<'b>,
) -> Result<ScopedRegister<'b>> {
Ok(ScopedRegister {
address,
fun,
transport,
})
}
pub fn mut_transport(&mut self) -> &mut Transport {
self.transport
}
}