wsio-core 0.12.11

Shared packet, event, and task primitives for ws.io.
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

use serde::{
    Deserialize,
    Serialize,
};
use serde_repr::{
    Deserialize_repr,
    Serialize_repr,
};

pub mod codecs;

// Enums
#[repr(u8)]
#[derive(Clone, Debug, Deserialize_repr, Serialize_repr)]
pub enum WsIoPacketType {
    Disconnect = 0,
    Event = 1,
    Init = 2,
    Ready = 3,
}

// Structs
#[derive(Deserialize)]
struct InnerPacket(WsIoPacketType, Option<String>, Option<Vec<u8>>);

#[derive(Serialize)]
struct InnerPacketRef<'a>(&'a WsIoPacketType, &'a Option<String>, &'a Option<Vec<u8>>);

#[derive(Clone, Debug)]
pub struct WsIoPacket {
    pub data: Option<Vec<u8>>,
    pub key: Option<String>,
    pub r#type: WsIoPacketType,
}

impl WsIoPacket {
    #[inline]
    pub fn new(r#type: WsIoPacketType, key: Option<&str>, data: Option<Vec<u8>>) -> Self {
        Self {
            data,
            key: key.map(str::to_owned),
            r#type,
        }
    }

    // Protected methods
    #[inline]
    pub(self) fn from_inner(inner: InnerPacket) -> Self {
        Self {
            data: inner.2,
            key: inner.1,
            r#type: inner.0,
        }
    }

    #[inline]
    pub(self) fn to_inner_ref(&self) -> InnerPacketRef<'_> {
        InnerPacketRef(&self.r#type, &self.key, &self.data)
    }

    // Public methods
    #[inline]
    pub fn new_disconnect() -> Self {
        Self::new(WsIoPacketType::Disconnect, None, None)
    }

    #[inline]
    pub fn new_event(event: impl Into<String>, data: Option<Vec<u8>>) -> Self {
        Self {
            data,
            key: Some(event.into()),
            r#type: WsIoPacketType::Event,
        }
    }

    #[inline]
    pub fn new_init(data: Option<Vec<u8>>) -> Self {
        Self::new(WsIoPacketType::Init, None, data)
    }

    #[inline]
    pub fn new_ready() -> Self {
        Self::new(WsIoPacketType::Ready, None, None)
    }
}

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

    #[test]
    fn test_new_packet_constructors() {
        // Disconnect
        let packet = WsIoPacket::new_disconnect();
        assert!(matches!(packet.r#type, WsIoPacketType::Disconnect));
        assert_eq!(packet.key, None);
        assert_eq!(packet.data, None);

        // Event without data
        let packet = WsIoPacket::new_event("chat", None);
        assert!(matches!(packet.r#type, WsIoPacketType::Event));
        assert_eq!(packet.key.as_deref(), Some("chat"));
        assert_eq!(packet.data, None);

        // Event with data
        let packet = WsIoPacket::new_event("chat", Some(vec![1, 2, 3]));
        assert!(matches!(packet.r#type, WsIoPacketType::Event));
        assert_eq!(packet.key.as_deref(), Some("chat"));
        assert_eq!(packet.data.as_deref(), Some(&[1, 2, 3][..]));

        // Init with data
        let packet = WsIoPacket::new_init(Some(vec![4, 5, 6]));
        assert!(matches!(packet.r#type, WsIoPacketType::Init));
        assert_eq!(packet.key, None);
        assert_eq!(packet.data.as_deref(), Some(&[4, 5, 6][..]));

        // Ready
        let packet = WsIoPacket::new_ready();
        assert!(matches!(packet.r#type, WsIoPacketType::Ready));
        assert_eq!(packet.key, None);
        assert_eq!(packet.data, None);
    }
}