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

use serde::{Deserialize, Serialize};

use super::status::ReplyStatus;
use super::value::{AlarmMeta, ParamValue, Timestamp};

/// Typed reply payload (minimal set).
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum ReplyPayload {
    Ack,
    Value(ParamValue),
    OctetData { data: Vec<u8>, nbytes: usize },
    Subscribed { subscription_id: u64 },
    Error { code: ReplyStatus, detail: String },
}

/// Reply envelope.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct PortReply {
    pub request_id: u64,
    pub payload: ReplyPayload,
    pub alarm: Option<AlarmMeta>,
    pub timestamp: Option<Timestamp>,
}

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

    #[test]
    fn serde_roundtrip_ack() {
        let reply = PortReply {
            request_id: 1,
            payload: ReplyPayload::Ack,
            alarm: None,
            timestamp: None,
        };
        let json = serde_json::to_string(&reply).unwrap();
        let back: PortReply = serde_json::from_str(&json).unwrap();
        assert_eq!(reply, back);
    }

    #[test]
    fn serde_roundtrip_value() {
        let reply = PortReply {
            request_id: 42,
            payload: ReplyPayload::Value(ParamValue::Int32(100)),
            alarm: Some(AlarmMeta { status: 1, severity: 2 }),
            timestamp: Some(Timestamp(1_000_000)),
        };
        let json = serde_json::to_string(&reply).unwrap();
        let back: PortReply = serde_json::from_str(&json).unwrap();
        assert_eq!(reply, back);
    }

    #[test]
    fn serde_roundtrip_octet_data() {
        let reply = PortReply {
            request_id: 3,
            payload: ReplyPayload::OctetData {
                data: vec![0x48, 0x65, 0x6c, 0x6c, 0x6f],
                nbytes: 5,
            },
            alarm: None,
            timestamp: None,
        };
        let json = serde_json::to_string(&reply).unwrap();
        let back: PortReply = serde_json::from_str(&json).unwrap();
        assert_eq!(reply, back);
    }

    #[test]
    fn serde_roundtrip_error() {
        let reply = PortReply {
            request_id: 99,
            payload: ReplyPayload::Error {
                code: ReplyStatus::Timeout,
                detail: "timed out waiting".into(),
            },
            alarm: None,
            timestamp: None,
        };
        let json = serde_json::to_string(&reply).unwrap();
        let back: PortReply = serde_json::from_str(&json).unwrap();
        assert_eq!(reply, back);
    }

    #[test]
    fn serde_roundtrip_subscribed() {
        let reply = PortReply {
            request_id: 7,
            payload: ReplyPayload::Subscribed { subscription_id: 42 },
            alarm: None,
            timestamp: None,
        };
        let json = serde_json::to_string(&reply).unwrap();
        let back: PortReply = serde_json::from_str(&json).unwrap();
        assert_eq!(reply, back);
    }

    #[test]
    fn serde_all_payload_variants() {
        let payloads = vec![
            ReplyPayload::Ack,
            ReplyPayload::Value(ParamValue::Float64(2.718)),
            ReplyPayload::OctetData { data: vec![1], nbytes: 1 },
            ReplyPayload::Subscribed { subscription_id: 0 },
            ReplyPayload::Error { code: ReplyStatus::Error, detail: "fail".into() },
        ];
        for payload in payloads {
            let json = serde_json::to_string(&payload).unwrap();
            let back: ReplyPayload = serde_json::from_str(&json).unwrap();
            assert_eq!(payload, back);
        }
    }
}