dnp3 1.6.0

Rust implementation of DNP3 (IEEE 1815) with idiomatic bindings for C, C++, .NET, and Java
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
111
112
113
114
115
116
117
118
119
120
121

use std::time::Duration;

/// A wrapper around a std::time::Duration that ensures values are in the range `[1ms .. 1hour]`
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
#[cfg_attr(feature = "serialization", serde(try_from = "Duration"))]
pub struct Timeout(pub(crate) Duration);

impl From<Timeout> for Duration {
    fn from(value: Timeout) -> Self {
        value.0
    }
}

impl Default for Timeout {
    fn default() -> Self {
        Self(Duration::from_secs(5))
    }
}

impl TryFrom<Duration> for Timeout {
    type Error = TimeoutRangeError;

    fn try_from(value: Duration) -> Result<Self, Self::Error> {
        Timeout::from_duration(value)
    }
}

/// Error type returned when a Timeout is constructed with an out-of-range value
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum TimeoutRangeError {
    /// value smaller than library allowed minimum
    TooSmall(Duration),
    /// value larger than library allowed maximum
    TooLarge(Duration),
}

impl Timeout {
    /// minimum allowed timeout value as a duration
    pub const MIN: Duration = Duration::from_millis(1);
    /// maximum allowed timeout value as a duration
    pub const MAX: Duration = Duration::from_secs(60 * 60); // one hour

    /// construct from a duration, saturating at the minimum and maximum
    pub fn saturating(value: Duration) -> Self {
        if value < Self::MIN {
            return Self(Self::MIN);
        }

        if value > Self::MAX {
            return Self(Self::MAX);
        }

        Self(value)
    }

    /// try to construct a `Timeout` from a count of seconds
    ///
    /// returns a `RangeError` is < `Timeout::MIN` or > `Timeout::MAX`
    pub fn from_secs(x: u64) -> Result<Self, TimeoutRangeError> {
        Self::from_duration(Duration::from_secs(x))
    }

    /// try to construct a `Timeout` from a count of milliseconds
    ///
    /// returns a `RangeError` is < `Timeout::MIN` or > `Timeout::MAX`
    pub fn from_millis(x: u64) -> Result<Self, TimeoutRangeError> {
        Self::from_duration(Duration::from_millis(x))
    }

    /// try to construct a `Timeout` from a `Duration`
    ///
    /// returns a `RangeError` is < `Timeout::MIN` or > `Timeout::MAX`
    pub fn from_duration(value: Duration) -> Result<Self, TimeoutRangeError> {
        if value < Self::MIN {
            return Err(TimeoutRangeError::TooSmall(value));
        }

        if value > Self::MAX {
            return Err(TimeoutRangeError::TooLarge(value));
        }

        Ok(Self(value))
    }

    pub(crate) fn deadline_from_now(self) -> tokio::time::Instant {
        // if this panics due to overflow we have bigger problems than the panic
        // it means the tim value being returned by now() is WAAAY too big
        tokio::time::Instant::now() + self.0
    }
}

impl std::fmt::Display for Timeout {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(f, "{} ms", self.0.as_millis())
    }
}

impl std::fmt::Display for TimeoutRangeError {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        match self {
            TimeoutRangeError::TooSmall(x) => write!(
                f,
                "specified duration ({} ms) smaller than allowed library minimum ({} ms)",
                x.as_millis(),
                Timeout::MIN.as_millis()
            ),
            TimeoutRangeError::TooLarge(x) => write!(
                f,
                "specified duration ({} ms) larger than allowed library maximum ({} ms)",
                x.as_millis(),
                Timeout::MAX.as_millis()
            ),
        }
    }
}

impl std::error::Error for TimeoutRangeError {}