sioc 0.1.0

Async Socket.IO client with type-safe event handling
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
141
142
143

use sioc::prelude::*;

#[derive(Debug, PartialEq, EventType, SerializePayload, DeserializePayload)]
struct Ping;

#[derive(Debug, PartialEq, EventType, SerializePayload, DeserializePayload)]
struct Moved(i32, i32);

#[derive(Debug, PartialEq, EventType, SerializePayload, DeserializePayload)]
struct Join {
    room: String,
    user: String,
}

/// Implicit name resolves to "auto_name".
#[derive(Debug, PartialEq, EventType, SerializePayload, DeserializePayload)]
struct AutoName;

#[derive(Debug, PartialEq, EventType, SerializePayload, DeserializePayload)]
struct Payload<T: serde::Serialize + serde::de::DeserializeOwned> {
    value: T,
}

/// Strict: rejects trailing elements.
#[derive(Debug, PartialEq, EventType, SerializePayload, DeserializePayload)]
#[sioc(strict)]
struct Chat(String);

/// Flatten: collects trailing elements into `tags`.
#[derive(Debug, PartialEq, EventType, SerializePayload, DeserializePayload)]
struct Stream {
    id: String,
    #[sioc(flatten)]
    tags: Vec<serde_json::Value>,
}

fn roundtrip<E>(val: E)
where
    E: std::fmt::Debug + PartialEq + EventType + SerializePayload + DeserializePayload,
{
    let bytes = event_to_json(&val).unwrap();
    assert_eq!(event_from_json::<E>(&bytes).unwrap(), val);
}

#[test]
fn name_explicit() {
    assert_eq!(Ping::NAME, "ping");
    assert_eq!(Moved::NAME, "moved");
    assert_eq!(Join::NAME, "join");
}

#[test]
fn name_implicit() {
    assert_eq!(AutoName::NAME, "auto_name");
}

#[test]
fn wire_unit() {
    assert_eq!(event_to_json(&Ping).unwrap(), "[\"ping\"]");
}

#[test]
fn wire_tuple() {
    assert_eq!(event_to_json(&Moved(3, -7)).unwrap(), "[\"moved\",3,-7]");
}

#[test]
fn wire_named() {
    assert_eq!(
        event_to_json(&Join {
            room: "lobby".into(),
            user: "alice".into()
        })
        .unwrap(),
        "[\"join\",\"lobby\",\"alice\"]",
    );
}

#[test]
fn roundtrip_unit() {
    roundtrip(Ping);
}

#[test]
fn roundtrip_tuple() {
    roundtrip(Moved(-1, 99));
}

#[test]
fn roundtrip_named() {
    roundtrip(Join {
        room: "general".into(),
        user: "bob".into(),
    });
}

#[test]
fn roundtrip_implicit_name() {
    roundtrip(AutoName);
}

#[test]
fn roundtrip_generic() {
    roundtrip(Payload {
        value: "sioc".to_string(),
    });
}

#[test]
fn wrong_name_fails() {
    assert!(event_from_json::<Ping>("[\"pong\"]").is_err());
}

#[test]
fn strict_rejects_trailing() {
    assert!(event_from_json::<Chat>("[\"chat\",\"hi\",null]").is_err());
}

#[test]
fn flexible_discards_trailing() {
    assert_eq!(event_from_json::<Ping>("[\"ping\",null,42]").unwrap(), Ping);
}

#[test]
fn flatten_collects() {
    use serde_json::json;
    let evt = event_from_json::<Stream>("[\"stream\",\"s1\",\"rock\",\"jazz\"]").unwrap();
    assert_eq!(
        evt,
        Stream {
            id: "s1".into(),
            tags: vec![json!("rock"), json!("jazz")]
        }
    );
}

#[test]
fn flatten_roundtrip() {
    roundtrip(Stream {
        id: "s1".into(),
        tags: vec![serde_json::json!(42)],
    });
}