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
//! A collection of examples to be used in the documentation.
mod lib {
#[tokio::test]
#[ignore = "Example"]
async fn client() {
use crate::mock::Noop;
use crate::{Message, WebSocket, http::Header, next, options::ConnectOptions};
// An already connected stream.
// Impl embedded_io_async Read + Write.
let stream = Noop;
let read_buffer = &mut [0u8; 1024];
let write_buffer = &mut [0u8; 1024];
let fragments_buffer = &mut [0u8; 1024];
// Impl rand_core RngCore.
let rng = Noop;
// Perform a WebSocket handshake as a client.
// 16 is the max number of headers to allocate space for.
let mut websocketz = WebSocket::connect::<16>(
// Set the connection options.
// The path for the WebSocket endpoint as well as any additional HTTP headers.
ConnectOptions::default()
.with_path("/ws")
.expect("Valid path")
.with_headers(&[
Header {
name: "Host",
value: b"example.com",
},
Header {
name: "User-Agent",
value: b"WebSocketz",
},
]),
stream,
rng,
read_buffer,
write_buffer,
fragments_buffer,
)
.await
.expect("Handshake failed");
// Send a text message.
websocketz
.send(Message::Text("Hello, WebSocket!"))
.await
.expect("Failed to send message");
// Receive messages in a loop.
loop {
match next!(websocketz) {
None => {
// Connection closed.
break;
}
Some(Ok(msg)) => {
// Handle received message.
let _ = msg;
}
Some(Err(err)) => {
// Handle error.
let _ = err;
break;
}
}
}
}
#[tokio::test]
#[ignore = "Example"]
async fn server() {
use crate::mock::Noop;
use crate::{Message, WebSocket, http::Header, next, options::AcceptOptions};
// An already connected stream.
// Impl embedded_io_async Read + Write.
let stream = Noop;
let read_buffer = &mut [0u8; 1024];
let write_buffer = &mut [0u8; 1024];
let fragments_buffer = &mut [0u8; 1024];
// Impl rand_core RngCore.
let rng: Noop = Noop;
// Perform a WebSocket handshake as a server.
// 16 is the max number of headers to allocate space for.
let mut websocketz = WebSocket::accept::<16>(
// Set the acceptance options.
// Any additional HTTP headers.
AcceptOptions::default().with_headers(&[Header {
name: "Server",
value: b"WebSocketz",
}]),
stream,
rng,
read_buffer,
write_buffer,
fragments_buffer,
)
.await
.expect("Handshake failed");
// Receive messages in a loop.
loop {
match next!(websocketz) {
None => {
// Connection closed.
break;
}
Some(Ok(msg)) => {
// Handle received message.
let _ = msg;
// Send a binary message.
if let Err(err) = websocketz.send(Message::Binary(b"Hello, WebSocket!")).await {
let _ = err;
break;
}
}
Some(Err(err)) => {
// Handle error.
let _ = err;
break;
}
}
}
}
#[tokio::test]
#[ignore = "Example"]
async fn next_macro() {
use crate::mock::Noop;
use crate::{WebSocket, next, options::ConnectOptions};
let stream = Noop;
let read_buffer = &mut [0u8; 1024];
let write_buffer = &mut [0u8; 1024];
let fragments_buffer = &mut [0u8; 1024];
let rng = Noop;
let websocketz = WebSocket::connect::<16>(
ConnectOptions::default()
.with_path("/ws")
.expect("Valid path"),
stream,
rng,
read_buffer,
write_buffer,
fragments_buffer,
)
.await
.expect("Handshake failed");
let existing_websocket = || websocketz;
let mut websocketz = existing_websocket();
while let Some(Ok(msg)) = next!(websocketz) {
// Messages hold references to the websocket buffers.
let _ = msg;
}
}
#[tokio::test]
#[ignore = "Example"]
async fn send_method_no_compile() {
use crate::mock::Noop;
use crate::{WebSocket, next, options::ConnectOptions};
let stream = Noop;
let read_buffer = &mut [0u8; 1024];
let write_buffer = &mut [0u8; 1024];
let fragments_buffer = &mut [0u8; 1024];
let rng = Noop;
let websocketz = WebSocket::connect::<16>(
ConnectOptions::default()
.with_path("/ws")
.expect("Valid path"),
stream,
rng,
read_buffer,
write_buffer,
fragments_buffer,
)
.await
.expect("Handshake failed");
let existing_websocket = || websocketz;
let mut websocketz = existing_websocket();
while let Some(Ok(_msg)) = next!(websocketz) {
// Messages hold references to the websocket buffers.
// So this will not compile:
// cannot borrow `websocketz` as mutable more than once at a time.
// websocketz.send(msg).await.expect("Failed to send message");
}
}
#[tokio::test]
#[ignore = "Example"]
async fn send_macro() {
use crate::mock::Noop;
use crate::{WebSocket, next, options::ConnectOptions, send};
let stream = Noop;
let read_buffer = &mut [0u8; 1024];
let write_buffer = &mut [0u8; 1024];
let fragments_buffer = &mut [0u8; 1024];
let rng = Noop;
let websocketz = WebSocket::connect::<16>(
ConnectOptions::default()
.with_path("/ws")
.expect("Valid path"),
stream,
rng,
read_buffer,
write_buffer,
fragments_buffer,
)
.await
.expect("Handshake failed");
let existing_websocket = || websocketz;
let mut websocketz = existing_websocket();
while let Some(Ok(msg)) = next!(websocketz) {
send!(websocketz, msg).expect("Failed to send message");
}
}
#[tokio::test]
#[ignore = "Example"]
async fn split() {
use crate::mock::Noop;
use crate::{Message, WebSocket, next, options::ConnectOptions};
let stream = Noop;
let read_buffer = &mut [0u8; 1024];
let write_buffer = &mut [0u8; 1024];
let fragments_buffer = &mut [0u8; 1024];
let rng = Noop;
let websocketz = WebSocket::connect::<16>(
ConnectOptions::default()
.with_path("/ws")
.expect("Valid path"),
stream,
rng,
read_buffer,
write_buffer,
fragments_buffer,
)
.await
.expect("Handshake failed");
let existing_websocket = || websocketz;
fn split(_stream: Noop) -> (Noop, Noop) {
// Let's assume we split the stream here.
(Noop, Noop)
}
let websocketz = existing_websocket();
let (mut websocketz_read, mut websocketz_write) = websocketz.split_with(split);
websocketz_write
.send(Message::Text("Hello, WebSocket!"))
.await
.expect("Failed to send message");
while let Some(Ok(msg)) = next!(websocketz_read) {
// `send` method works here,
// because `websocketz_read` and `websocketz_write` do not hold the same references.
websocketz_write
.send(msg)
.await
.expect("Failed to send message");
}
}
}