asyn-rs 0.6.1

Rust port of EPICS asyn - async device I/O framework
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

use serde::{Deserialize, Serialize};

use super::value::{ParamValue, Timestamp};
use crate::exception::AsynException;

/// Protocol-level event payload.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum EventPayload {
    ValueChanged {
        reason: usize,
        addr: i32,
        value: ParamValue,
    },
    Exception {
        exception: ProtocolException,
        port_name: String,
        addr: i32,
    },
}

/// Serializable mirror of `AsynException`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum ProtocolException {
    Connect,
    Enable,
    AutoConnect,
    TraceMask,
    TraceIoMask,
    TraceInfoMask,
    TraceFile,
    TraceIoTruncateSize,
    Shutdown,
}

impl From<AsynException> for ProtocolException {
    fn from(e: AsynException) -> Self {
        match e {
            AsynException::Connect => Self::Connect,
            AsynException::Enable => Self::Enable,
            AsynException::AutoConnect => Self::AutoConnect,
            AsynException::TraceMask => Self::TraceMask,
            AsynException::TraceIoMask => Self::TraceIoMask,
            AsynException::TraceInfoMask => Self::TraceInfoMask,
            AsynException::TraceFile => Self::TraceFile,
            AsynException::TraceIoTruncateSize => Self::TraceIoTruncateSize,
            AsynException::Shutdown => Self::Shutdown,
        }
    }
}

impl From<ProtocolException> for AsynException {
    fn from(e: ProtocolException) -> Self {
        match e {
            ProtocolException::Connect => Self::Connect,
            ProtocolException::Enable => Self::Enable,
            ProtocolException::AutoConnect => Self::AutoConnect,
            ProtocolException::TraceMask => Self::TraceMask,
            ProtocolException::TraceIoMask => Self::TraceIoMask,
            ProtocolException::TraceInfoMask => Self::TraceInfoMask,
            ProtocolException::TraceFile => Self::TraceFile,
            ProtocolException::TraceIoTruncateSize => Self::TraceIoTruncateSize,
            ProtocolException::Shutdown => Self::Shutdown,
        }
    }
}

/// Event filter for subscriptions.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventFilter {
    pub reason: Option<usize>,
    pub addr: Option<i32>,
}

/// Full protocol event envelope.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct PortEvent {
    pub port_name: String,
    pub payload: EventPayload,
    pub timestamp: Timestamp,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn serde_value_changed() {
        let evt = PortEvent {
            port_name: "myport".into(),
            payload: EventPayload::ValueChanged {
                reason: 0,
                addr: 1,
                value: ParamValue::Float64(2.5),
            },
            timestamp: Timestamp(1_000_000),
        };
        let json = serde_json::to_string(&evt).unwrap();
        let back: PortEvent = serde_json::from_str(&json).unwrap();
        assert_eq!(evt, back);
    }

    #[test]
    fn serde_exception() {
        let evt = PortEvent {
            port_name: "p".into(),
            payload: EventPayload::Exception {
                exception: ProtocolException::Connect,
                port_name: "p".into(),
                addr: -1,
            },
            timestamp: Timestamp(0),
        };
        let json = serde_json::to_string(&evt).unwrap();
        let back: PortEvent = serde_json::from_str(&json).unwrap();
        assert_eq!(evt, back);
    }

    #[test]
    fn exception_roundtrip() {
        let exceptions = [
            AsynException::Connect,
            AsynException::Enable,
            AsynException::AutoConnect,
            AsynException::Shutdown,
        ];
        for e in exceptions {
            let proto: ProtocolException = e.into();
            let back: AsynException = proto.into();
            assert_eq!(e, back);
        }
    }

    #[test]
    fn event_filter_serde() {
        let filter = EventFilter { reason: Some(3), addr: Some(0) };
        let json = serde_json::to_string(&filter).unwrap();
        let back: EventFilter = serde_json::from_str(&json).unwrap();
        assert_eq!(filter, back);
    }
}