mbus-core 0.14.0

Protocol types, errors, function codes, and transport traits for the modbus-rs workspace
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
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

//! Transport-layer error and type-classification types.

#[cfg(all(feature = "defmt-format", target_os = "none"))]
use defmt;

use crate::errors::MbusError;

use super::config::SerialMode;

/// Represents errors that can occur at the Modbus transport layer.
#[derive(Debug, PartialEq, Eq)]
pub enum TransportError {
    /// The connection attempt failed.
    ConnectionFailed,
    /// The connection was unexpectedly closed.
    ConnectionClosed,
    /// An I/O error occurred during send or receive.
    IoError,
    /// A timeout occurred during a network operation.
    Timeout,
    /// The received data was too large for the buffer.
    BufferTooSmall,
    /// An unexpected error occurred.
    Unexpected,
    /// Invalid configuration.
    InvalidConfiguration,
    /// The transport detected a protocol-level framing or timing violation
    /// (e.g., inter-character gap exceeding t1.5 on serial RTU).
    FramingError,
}

#[cfg(all(feature = "defmt-format", target_os = "none"))]
impl defmt::Format for TransportError {
    fn format(&self, f: defmt::Formatter) {
        match self {
            TransportError::ConnectionFailed => defmt::write!(f, "Connection failed"),
            TransportError::ConnectionClosed => defmt::write!(f, "Connection closed"),
            TransportError::IoError => defmt::write!(f, "I/O error"),
            TransportError::Timeout => defmt::write!(f, "Timeout"),
            TransportError::BufferTooSmall => defmt::write!(f, "Buffer too small"),
            TransportError::Unexpected => defmt::write!(f, "An unexpected error occurred"),
            TransportError::InvalidConfiguration => defmt::write!(f, "Invalid configuration"),
            TransportError::FramingError => {
                defmt::write!(f, "Framing error: protocol timing violation")
            }
        }
    }
}

#[cfg(feature = "error-trait")]
impl core::fmt::Display for TransportError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            TransportError::ConnectionFailed => write!(f, "Connection failed"),
            TransportError::ConnectionClosed => write!(f, "Connection closed"),
            TransportError::IoError => write!(f, "I/O error"),
            TransportError::Timeout => write!(f, "Timeout"),
            TransportError::BufferTooSmall => write!(f, "Buffer too small"),
            TransportError::Unexpected => write!(f, "Unexpected error"),
            TransportError::InvalidConfiguration => write!(f, "Invalid configuration"),
            TransportError::FramingError => write!(f, "Framing error"),
        }
    }
}

#[cfg(feature = "error-trait")]
impl core::error::Error for TransportError {}

impl From<TransportError> for MbusError {
    fn from(err: TransportError) -> Self {
        match err {
            TransportError::ConnectionFailed => MbusError::ConnectionFailed,
            TransportError::ConnectionClosed => MbusError::ConnectionClosed,
            TransportError::IoError => MbusError::IoError,
            TransportError::Timeout => MbusError::Timeout,
            TransportError::BufferTooSmall => MbusError::BufferTooSmall,
            TransportError::Unexpected => MbusError::Unexpected,
            TransportError::InvalidConfiguration => MbusError::InvalidConfiguration,
            TransportError::FramingError => MbusError::FramingError,
        }
    }
}

/// An enumeration to specify the type of transport to use.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TransportType {
    /// Standard library TCP transport implementation.
    StdTcp,
    /// Standard library Serial transport implementation.
    StdSerial(SerialMode),
    /// Custom TCP transport implementation.
    CustomTcp,
    /// Custom Serial transport implementation.
    CustomSerial(SerialMode),
}

impl TransportType {
    /// Returns `true` if the transport type is TCP (StdTcp or CustomTcp).
    pub fn is_tcp_type(&self) -> bool {
        matches!(self, TransportType::StdTcp | TransportType::CustomTcp)
    }

    /// Returns `true` if the transport type is serial (RTU or ASCII).
    pub fn is_serial_type(&self) -> bool {
        matches!(
            self,
            TransportType::StdSerial(_) | TransportType::CustomSerial(_)
        )
    }
}