fennec-modbus 0.87.0

Modular Modbus client implementation
Documentation 
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

//! The lowest protocol level.
//!
//! It operates with PDU's and independent of any transport.
//! If you're implementing transport like PDU, you're going to need this module:
//!
//! - **Data units** are the PDU's that you're going to wrap into your transport.
//! - **Functions** are the actual Modbus functions expressed in terms of function code,
//!   request arguments and output.

pub mod data_unit;
mod error;
mod exception;
pub mod function;
pub mod r#struct;

pub use self::{error::Error, exception::*};
use crate::protocol::r#struct::{Readable, Writable};

/// Trait that ties function code, arguments and output together.
///
/// Users are free to implement their own functions – be that custom Modbus functions
/// or alternate standard function implementations. In the latter case, consider
/// [making a pull request](https://github.com/eigenein/fennec/pulls).
pub trait Function {
    /// Modbus function code.
    const CODE: u8;

    /// Function arguments type.
    ///
    /// Note that this writable type *must not* include the function code.
    type Args: Writable;

    /// Function result type.
    ///
    /// Note that this readable type *must not* include the function code.
    type Output: Readable;
}