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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
#[cfg(test)]
mod tests;
mod frame;
mod mask;
pub use frame::*;
pub use mask::apply_mask;
use derive_more::Display;
use std::convert::TryFrom;
use thiserror::Error;
bitflags::bitflags! {
pub struct HeaderFlags: u8 {
const FIN = 0b1000_0000;
const RSV_1 = 0b0100_0000;
const RSV_2 = 0b0010_0000;
const RSV_3 = 0b0001_0000;
const RESERVED = Self::RSV_1.bits | Self::RSV_2.bits | Self::RSV_3.bits;
}
}
#[allow(warnings)]
impl HeaderFlags {
pub fn is_fin(&self) -> bool {
self.contains(HeaderFlags::FIN)
}
pub fn is_rsv1(&self) -> bool {
self.contains(HeaderFlags::RSV_1)
}
pub fn is_rsv2(&self) -> bool {
self.contains(HeaderFlags::RSV_2)
}
pub fn is_rsv3(&self) -> bool {
self.contains(HeaderFlags::RSV_3)
}
}
#[derive(Clone, Debug, PartialEq)]
pub enum Message {
Text,
Binary,
Ping,
Pong,
Close(Option<CloseReason>),
}
impl Message {
pub fn is_text(&self) -> bool {
matches!(self, Message::Text)
}
pub fn is_binary(&self) -> bool {
matches!(self, Message::Binary)
}
pub fn is_ping(&self) -> bool {
matches!(self, Message::Ping)
}
pub fn is_pong(&self) -> bool {
matches!(self, Message::Pong)
}
pub fn is_close(&self) -> bool {
matches!(self, Message::Close(_))
}
}
#[derive(Copy, Clone, Debug)]
pub enum PayloadType {
Text,
Binary,
Ping,
}
#[derive(Copy, Clone, Debug)]
pub enum MessageType {
Text,
Binary,
}
#[derive(PartialEq, Debug, Copy, Clone)]
pub struct WebSocketConfig {
pub max_message_size: usize,
}
impl Default for WebSocketConfig {
fn default() -> Self {
WebSocketConfig {
max_message_size: 64 << 20,
}
}
}
#[derive(Debug, Copy, Clone, PartialEq)]
pub enum Role {
Client,
Server,
}
impl Role {
pub fn is_client(&self) -> bool {
matches!(self, Role::Client)
}
pub fn is_server(&self) -> bool {
matches!(self, Role::Server)
}
}
#[derive(Debug, Copy, Clone, Display, PartialEq)]
pub enum OpCode {
#[display(fmt = "{}", _0)]
DataCode(DataCode),
#[display(fmt = "{}", _0)]
ControlCode(ControlCode),
}
impl OpCode {
pub fn is_data(&self) -> bool {
matches!(self, OpCode::DataCode(_))
}
pub fn is_control(&self) -> bool {
matches!(self, OpCode::ControlCode(_))
}
}
impl From<OpCode> for u8 {
fn from(op: OpCode) -> Self {
match op {
OpCode::DataCode(code) => code as u8,
OpCode::ControlCode(code) => code as u8,
}
}
}
#[derive(Debug, Copy, Clone, Display, PartialEq)]
pub enum DataCode {
Continuation = 0,
Text = 1,
Binary = 2,
}
impl From<DataCode> for ratchet_ext::OpCode {
fn from(e: DataCode) -> Self {
match e {
DataCode::Continuation => ratchet_ext::OpCode::Continuation,
DataCode::Text => ratchet_ext::OpCode::Text,
DataCode::Binary => ratchet_ext::OpCode::Binary,
}
}
}
#[derive(Debug, Copy, Clone, Display, PartialEq)]
pub enum ControlCode {
Close = 8,
Ping = 9,
Pong = 10,
}
#[derive(Copy, Clone, Debug, Error, PartialEq)]
pub enum OpCodeParseErr {
#[error("Reserved OpCode: `{0}`")]
Reserved(u8),
#[error("Invalid OpCode: `{0}`")]
Invalid(u8),
}
impl TryFrom<u8> for OpCode {
type Error = OpCodeParseErr;
fn try_from(value: u8) -> Result<Self, Self::Error> {
match value {
0 => Ok(OpCode::DataCode(DataCode::Continuation)),
1 => Ok(OpCode::DataCode(DataCode::Text)),
2 => Ok(OpCode::DataCode(DataCode::Binary)),
r @ 3..=7 => Err(OpCodeParseErr::Reserved(r)),
8 => Ok(OpCode::ControlCode(ControlCode::Close)),
9 => Ok(OpCode::ControlCode(ControlCode::Ping)),
10 => Ok(OpCode::ControlCode(ControlCode::Pong)),
r @ 11..=15 => Err(OpCodeParseErr::Reserved(r)),
e => Err(OpCodeParseErr::Invalid(e)),
}
}
}
#[derive(Debug, Clone, PartialEq)]
pub struct CloseReason {
pub code: CloseCode,
pub description: Option<String>,
}
impl CloseReason {
#[allow(missing_docs)]
pub fn new(code: CloseCode, description: Option<String>) -> Self {
CloseReason { code, description }
}
}
#[allow(missing_docs)]
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum CloseCode {
Normal,
GoingAway,
Protocol,
Unsupported,
Status,
Abnormal,
Invalid,
Policy,
Overflow,
Extension,
Unexpected,
Restarting,
TryAgain,
Tls,
ReservedExtension(u16),
Library(u16),
Application(u16),
}
impl CloseCode {
pub(crate) fn is_illegal(&self) -> bool {
matches!(
self,
CloseCode::Status
| CloseCode::Tls
| CloseCode::Abnormal
| CloseCode::ReservedExtension(_)
)
}
}
#[derive(Copy, Clone, Error, Debug)]
#[error("Unknown close code: `{0}`")]
pub struct CloseCodeParseErr(pub(crate) u16);
impl TryFrom<[u8; 2]> for CloseCode {
type Error = CloseCodeParseErr;
fn try_from(value: [u8; 2]) -> Result<Self, Self::Error> {
let value = u16::from_be_bytes(value);
match value {
n @ 0..=999 => Err(CloseCodeParseErr(n)),
1000 => Ok(CloseCode::Normal),
1001 => Ok(CloseCode::GoingAway),
1002 => Ok(CloseCode::Protocol),
1003 => Ok(CloseCode::Unsupported),
1005 => Ok(CloseCode::Status),
1006 => Ok(CloseCode::Abnormal),
1007 => Ok(CloseCode::Invalid),
1008 => Ok(CloseCode::Policy),
1009 => Ok(CloseCode::Overflow),
1010 => Ok(CloseCode::Extension),
1011 => Ok(CloseCode::Unexpected),
1012 => Ok(CloseCode::Restarting),
1013 => Ok(CloseCode::TryAgain),
1015 => Ok(CloseCode::Tls),
n @ 1016..=1999 => Err(CloseCodeParseErr(n)),
n @ 2000..=2999 => Ok(CloseCode::ReservedExtension(n)),
n @ 3000..=3999 => Ok(CloseCode::Library(n)),
n @ 4000..=4999 => Ok(CloseCode::Application(n)),
n => Err(CloseCodeParseErr(n)),
}
}
}
impl From<CloseCode> for u16 {
fn from(code: CloseCode) -> u16 {
match code {
CloseCode::Normal => 1000,
CloseCode::GoingAway => 1001,
CloseCode::Protocol => 1002,
CloseCode::Unsupported => 1003,
CloseCode::Status => 1005,
CloseCode::Abnormal => 1006,
CloseCode::Invalid => 1007,
CloseCode::Policy => 1008,
CloseCode::Overflow => 1009,
CloseCode::Extension => 1010,
CloseCode::Unexpected => 1011,
CloseCode::Restarting => 1012,
CloseCode::TryAgain => 1013,
CloseCode::Tls => 1015,
CloseCode::ReservedExtension(n) => n,
CloseCode::Library(n) => n,
CloseCode::Application(n) => n,
}
}
}