rust-oxide-realtime 0.2.0

Reusable realtime transport primitives for Axum servers and Rust websocket clients
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

use chrono::Utc;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use uuid::Uuid;

pub const DEFAULT_EVENT: &str = "message";

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ErrorPayload {
    pub code: String,
    pub message: String,
}

impl ErrorPayload {
    pub fn new(code: impl Into<String>, message: impl Into<String>) -> Self {
        Self {
            code: code.into(),
            message: message.into(),
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "op", rename_all = "snake_case")]
pub enum ClientFrame {
    ChannelJoin {
        id: String,
        channel: String,
        #[serde(default)]
        ts: Option<i64>,
    },
    ChannelLeave {
        id: String,
        channel: String,
        #[serde(default)]
        ts: Option<i64>,
    },
    ChannelEmit {
        id: String,
        channel: String,
        event: String,
        #[serde(default)]
        data: Value,
        #[serde(default)]
        ts: Option<i64>,
    },
    Ping {
        id: String,
        #[serde(default)]
        ts: Option<i64>,
    },
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "op", rename_all = "snake_case")]
pub enum ServerFrame {
    Connected {
        id: String,
        conn_id: String,
        user_id: String,
        ts: i64,
    },
    Joined {
        id: String,
        channel: String,
        ts: i64,
    },
    Left {
        id: String,
        channel: String,
        ts: i64,
    },
    Event {
        id: String,
        channel: String,
        event: String,
        data: Value,
        from_user: Option<String>,
        ts: i64,
    },
    Ack {
        id: String,
        for_id: String,
        ok: bool,
        error: Option<ErrorPayload>,
        ts: i64,
    },
    Pong {
        id: String,
        ts: i64,
    },
    Error {
        id: String,
        error: ErrorPayload,
        ts: i64,
    },
}

impl ServerFrame {
    pub fn connected(conn_id: impl Into<String>, user_id: impl Into<String>) -> Self {
        Self::Connected {
            id: random_id(),
            conn_id: conn_id.into(),
            user_id: user_id.into(),
            ts: now_unix_i64(),
        }
    }

    pub fn event(
        channel: impl Into<String>,
        event: impl Into<String>,
        data: Value,
        from_user: Option<String>,
    ) -> Self {
        Self::Event {
            id: random_id(),
            channel: channel.into(),
            event: event.into(),
            data,
            from_user,
            ts: now_unix_i64(),
        }
    }

    pub fn ack_ok(for_id: impl Into<String>) -> Self {
        Self::Ack {
            id: random_id(),
            for_id: for_id.into(),
            ok: true,
            error: None,
            ts: now_unix_i64(),
        }
    }

    pub fn ack_err(for_id: impl Into<String>, code: &str, message: &str) -> Self {
        Self::Ack {
            id: random_id(),
            for_id: for_id.into(),
            ok: false,
            error: Some(ErrorPayload::new(code, message)),
            ts: now_unix_i64(),
        }
    }

    pub fn pong(for_id: impl Into<String>) -> Self {
        Self::Pong {
            id: for_id.into(),
            ts: now_unix_i64(),
        }
    }

    pub fn error(code: &str, message: &str) -> Self {
        Self::Error {
            id: random_id(),
            error: ErrorPayload::new(code, message),
            ts: now_unix_i64(),
        }
    }
}

fn random_id() -> String {
    Uuid::new_v4().to_string()
}

fn now_unix_i64() -> i64 {
    Utc::now().timestamp()
}