roboplc 0.6.4

Framework for PLCs and real-time micro-services
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
38
39
40
41
42
43
44

//!
//! The module provides mapping for various protocols. Structural mapping is built on top of
//! the [binrw](https://crates.io/crates/binrw) crate.
pub use binrw;
use binrw::{BinRead, BinWrite};

use crate::Result;

#[cfg(feature = "eapi")]
/// EVA ICS local bus API
pub mod eapi;
#[cfg(all(feature = "input-events", target_os = "linux"))]
/// Keyboard input events
pub mod keyboard;
#[cfg(feature = "modbus")]
/// Modbus communication
pub mod modbus;
/// Linux process communication
#[cfg(feature = "pipe")]
/// Subprocess pipes
pub mod pipe;
/// Raw UDP communication
pub mod raw_udp;

/// Generic I/O mapping trait
#[allow(clippy::module_name_repetitions)]
pub trait IoMapping {
    /// Options for the mapping
    type Options;
    /// Read data from the raw buffer
    fn read<T>(&mut self) -> Result<T>
    where
        T: for<'a> BinRead<Args<'a> = ()>;
    /// Write data to the raw buffer
    fn write<T>(&mut self, value: T) -> Result<()>
    where
        T: for<'a> BinWrite<Args<'a> = ()>;
}

/// I/O mapping prelude
pub mod prelude {
    pub use super::IoMapping as _;
    pub use binrw::prelude::*;
}