remoc 0.18.3

🦑 Remote multiplexed objects, channels, observable collections and RPC making remote interactions seamless. Provides multiple remote channels and RPC over TCP, TLS or any other transport.
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
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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
use std::time::Duration;

#[cfg(feature = "js")]
use wasm_bindgen_test::wasm_bindgen_test;

use remoc::{
    exec::time::sleep,
    robs::vec_deque::{ObservableVecDeque, VecDequeEvent},
};

#[cfg_attr(not(feature = "js"), tokio::test)]
#[cfg_attr(feature = "js", wasm_bindgen_test)]
async fn standalone() {
    let mut obs: ObservableVecDeque<_, remoc::codec::Default> = ObservableVecDeque::new();

    obs.push_back(0);
    obs.push_front(10);
    obs.push_back(20);
    assert_eq!(obs.pop_back(), Some(20));
    assert_eq!(obs.pop_front(), Some(10));

    obs.remove(0);
    assert_eq!(obs.len(), 0);

    obs.clear();
}

#[cfg_attr(not(feature = "js"), tokio::test)]
#[cfg_attr(feature = "js", wasm_bindgen_test)]
async fn events() {
    let mut obs: ObservableVecDeque<_, remoc::codec::Default> = ObservableVecDeque::new();

    let mut sub = obs.subscribe(1024);
    assert!(!sub.is_complete());
    assert!(!sub.is_done());

    use std::collections::VecDeque;
    assert_eq!(sub.take_initial(), Some(VecDeque::new()));
    assert!(sub.is_complete());
    assert!(!sub.is_done());

    obs.push_back(0u32);
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushBack(0)));

    obs.push_front(10);
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushFront(10)));

    obs.push_back(20);
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushBack(20)));

    assert_eq!(obs.pop_back(), Some(20));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PopBack));

    assert_eq!(obs.pop_front(), Some(10));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PopFront));

    obs.insert(0, 30);
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::Insert(0, 30)));

    *obs.get_mut(0).unwrap() = 50;
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::Set(0, 50)));

    assert_eq!(obs.remove(0), Some(50));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::Remove(0)));

    obs.push_back(60);
    obs.push_back(70);
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushBack(60)));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushBack(70)));

    obs.clear();
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::Clear));

    obs.done();
    assert!(obs.is_done());
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::Done));
    assert_eq!(sub.recv().await.unwrap(), None);
    assert!(sub.is_done());
}

#[cfg_attr(not(feature = "js"), tokio::test)]
#[cfg_attr(feature = "js", wasm_bindgen_test)]
async fn incremental() {
    let mut obs: ObservableVecDeque<_, remoc::codec::Default> = ObservableVecDeque::new();
    obs.push_back(0u32);
    obs.push_back(10);
    obs.push_back(20);

    let mut sub = obs.subscribe_incremental(1024);
    assert!(!sub.is_complete());
    assert!(!sub.is_done());

    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushBack(0)));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushBack(10)));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushBack(20)));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::InitialComplete));
    assert!(sub.is_complete());

    obs.push_front(30);
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushFront(30)));

    obs.done();
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::Done));
    assert_eq!(sub.recv().await.unwrap(), None);
}

#[cfg_attr(not(feature = "js"), tokio::test)]
#[cfg_attr(feature = "js", wasm_bindgen_test)]
async fn mirror() {
    let mut obs: ObservableVecDeque<_, remoc::codec::Default> = ObservableVecDeque::new();
    obs.push_back(0u32);
    obs.push_back(10);
    obs.push_back(20);

    let sub = obs.subscribe(1024);
    let mut mir = sub.mirror(1024);

    sleep(Duration::from_millis(10)).await;

    {
        let borrow = mir.borrow().await.unwrap();
        assert_eq!(borrow.len(), 3);
        assert_eq!(borrow[0], 0);
        assert_eq!(borrow[1], 10);
        assert_eq!(borrow[2], 20);
        assert!(borrow.is_complete());
        assert!(!borrow.is_done());
    }

    obs.push_front(30);
    mir.changed().await;

    {
        let borrow = mir.borrow().await.unwrap();
        assert_eq!(borrow.len(), 4);
        assert_eq!(borrow[0], 30);
        assert_eq!(borrow[1], 0);
        assert_eq!(borrow[2], 10);
        assert_eq!(borrow[3], 20);
    }

    obs.pop_back();
    mir.changed().await;

    {
        let borrow = mir.borrow().await.unwrap();
        assert_eq!(borrow.len(), 3);
        assert_eq!(borrow[0], 30);
        assert_eq!(borrow[1], 0);
        assert_eq!(borrow[2], 10);
    }

    obs.done();
    mir.changed().await;

    {
        let borrow = mir.borrow().await.unwrap();
        assert!(borrow.is_done());
    }

    use std::collections::VecDeque;
    let final_state = mir.detach().await;
    let mut expected = VecDeque::new();
    expected.push_back(30);
    expected.push_back(0);
    expected.push_back(10);
    assert_eq!(final_state, expected);
}

#[cfg_attr(not(feature = "js"), tokio::test)]
#[cfg_attr(feature = "js", wasm_bindgen_test)]
async fn mirror_incremental() {
    let mut obs: ObservableVecDeque<_, remoc::codec::Default> = ObservableVecDeque::new();
    obs.push_back(0u32);
    obs.push_back(10);
    obs.push_back(20);

    let sub = obs.subscribe_incremental(1024);
    let mut mir = sub.mirror(1024);

    sleep(Duration::from_millis(100)).await;

    {
        let borrow = mir.borrow().await.unwrap();
        assert_eq!(borrow.len(), 3);
        assert_eq!(borrow[0], 0);
        assert_eq!(borrow[1], 10);
        assert_eq!(borrow[2], 20);
        assert!(borrow.is_complete());
        assert!(!borrow.is_done());
    }

    obs.push_front(30);
    mir.changed().await;
    sleep(Duration::from_millis(10)).await;

    {
        let borrow = mir.borrow().await.unwrap();
        assert_eq!(borrow.len(), 4);
        assert_eq!(borrow[0], 30);
    }

    obs.done();
    mir.changed().await;
    sleep(Duration::from_millis(10)).await;

    {
        let borrow = mir.borrow().await.unwrap();
        assert!(borrow.is_done());
    }
}

#[cfg_attr(not(feature = "js"), tokio::test)]
#[cfg_attr(feature = "js", wasm_bindgen_test)]
async fn swap_remove() {
    let mut obs: ObservableVecDeque<_, remoc::codec::Default> = ObservableVecDeque::new();

    let mut sub = obs.subscribe(1024);
    assert_eq!(sub.take_initial(), Some(std::collections::VecDeque::new()));

    obs.push_back(0u32);
    obs.push_back(10);
    obs.push_back(20);
    obs.push_back(30);

    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushBack(0)));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushBack(10)));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushBack(20)));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushBack(30)));

    // Test swap_remove_back - it should remove element at index 1 (value 10) and replace with last element (30)
    assert_eq!(obs.swap_remove_back(1), Some(10));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::SwapRemoveBack(1)));

    // After swap_remove_back(1), the deque should be [0, 30, 20]
    // Test swap_remove_front - it should remove element at index 1 (value 30) and replace with first element (0)
    assert_eq!(obs.swap_remove_front(1), Some(30));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::SwapRemoveFront(1)));
}

#[cfg_attr(not(feature = "js"), tokio::test)]
#[cfg_attr(feature = "js", wasm_bindgen_test)]
async fn pop_operations_comprehensive() {
    let mut obs: ObservableVecDeque<_, remoc::codec::Default> = ObservableVecDeque::new();
    let mut sub = obs.subscribe(1024);

    use std::collections::VecDeque;
    assert_eq!(sub.take_initial(), Some(VecDeque::new()));

    // Test popping from empty deque
    assert_eq!(obs.pop_front(), None);
    assert_eq!(obs.pop_back(), None);
    // No events should be sent for failed pops

    // Add some elements
    obs.push_back(10);
    obs.push_back(20);
    obs.push_front(5);
    obs.push_front(1);
    // Deque is now: [1, 5, 10, 20]

    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushBack(10)));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushBack(20)));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushFront(5)));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushFront(1)));

    // Test pop_front
    assert_eq!(obs.pop_front(), Some(1));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PopFront));
    assert_eq!(obs.len(), 3);

    // Test pop_back
    assert_eq!(obs.pop_back(), Some(20));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PopBack));
    assert_eq!(obs.len(), 2);

    // Continue alternating pops
    assert_eq!(obs.pop_front(), Some(5));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PopFront));
    assert_eq!(obs.len(), 1);

    assert_eq!(obs.pop_back(), Some(10));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PopBack));
    assert_eq!(obs.len(), 0);

    // Test popping from empty again
    assert_eq!(obs.pop_front(), None);
    assert_eq!(obs.pop_back(), None);

    obs.done();
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::Done));
}

#[cfg_attr(not(feature = "js"), tokio::test)]
#[cfg_attr(feature = "js", wasm_bindgen_test)]
async fn pop_operations_single_element() {
    let mut obs: ObservableVecDeque<_, remoc::codec::Default> = ObservableVecDeque::new();
    let mut sub = obs.subscribe(1024);

    use std::collections::VecDeque;
    assert_eq!(sub.take_initial(), Some(VecDeque::new()));

    // Test pop_front on single element
    obs.push_back(42);
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushBack(42)));

    assert_eq!(obs.pop_front(), Some(42));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PopFront));
    assert_eq!(obs.len(), 0);

    // Test pop_back on single element
    obs.push_front(99);
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PushFront(99)));

    assert_eq!(obs.pop_back(), Some(99));
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::PopBack));
    assert_eq!(obs.len(), 0);

    obs.done();
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::Done));
}

#[cfg_attr(not(feature = "js"), tokio::test)]
#[cfg_attr(feature = "js", wasm_bindgen_test)]
async fn pop_operations_mirror() {
    let mut obs: ObservableVecDeque<_, remoc::codec::Default> = ObservableVecDeque::new();

    // Pre-populate with some data
    obs.push_back(10);
    obs.push_back(20);
    obs.push_front(5);
    // Deque is now: [5, 10, 20]

    let sub = obs.subscribe(1024);
    let mut mir = sub.mirror(1024);

    sleep(Duration::from_millis(10)).await;

    // Verify initial state
    {
        let borrow = mir.borrow().await.unwrap();
        assert_eq!(borrow.len(), 3);
        assert_eq!(borrow[0], 5);
        assert_eq!(borrow[1], 10);
        assert_eq!(borrow[2], 20);
    }

    // Test pop_front
    assert_eq!(obs.pop_front(), Some(5));
    mir.changed().await;

    {
        let borrow = mir.borrow().await.unwrap();
        assert_eq!(borrow.len(), 2);
        assert_eq!(borrow[0], 10);
        assert_eq!(borrow[1], 20);
    }

    // Test pop_back
    assert_eq!(obs.pop_back(), Some(20));
    mir.changed().await;

    {
        let borrow = mir.borrow().await.unwrap();
        assert_eq!(borrow.len(), 1);
        assert_eq!(borrow[0], 10);
    }

    // Pop the last element
    assert_eq!(obs.pop_front(), Some(10));
    mir.changed().await;

    {
        let borrow = mir.borrow().await.unwrap();
        assert_eq!(borrow.len(), 0);
        assert!(borrow.is_empty());
    }

    // Add more elements and test different patterns
    obs.push_back(100);
    obs.push_front(50);
    obs.push_back(150);
    mir.changed().await;

    {
        let borrow = mir.borrow().await.unwrap();
        assert_eq!(borrow.len(), 3);
        assert_eq!(borrow[0], 50);
        assert_eq!(borrow[1], 100);
        assert_eq!(borrow[2], 150);
    }

    obs.done();
    mir.changed().await;

    use std::collections::VecDeque;
    let final_state = mir.detach().await;
    let mut expected = VecDeque::new();
    expected.push_back(50);
    expected.push_back(100);
    expected.push_back(150);
    assert_eq!(final_state, expected);
}

#[cfg_attr(not(feature = "js"), tokio::test)]
#[cfg_attr(feature = "js", wasm_bindgen_test)]
async fn pop_operations_stress_test() {
    let mut obs: ObservableVecDeque<_, remoc::codec::Default> = ObservableVecDeque::new();
    let mut sub = obs.subscribe(2048);

    use std::collections::VecDeque;
    assert_eq!(sub.take_initial(), Some(VecDeque::new()));

    // Stress test with many push/pop operations
    let mut expected_events = Vec::new();

    // Fill the deque
    for i in 0..10 {
        obs.push_back(i);
        expected_events.push(VecDequeEvent::PushBack(i));
    }

    for i in 10..20 {
        obs.push_front(i);
        expected_events.push(VecDequeEvent::PushFront(i));
    }

    // Now pop elements in various patterns
    // Pop from front 5 times
    for _ in 0..5 {
        let val = obs.pop_front();
        assert!(val.is_some());
        expected_events.push(VecDequeEvent::PopFront);
    }

    // Pop from back 3 times
    for _ in 0..3 {
        let val = obs.pop_back();
        assert!(val.is_some());
        expected_events.push(VecDequeEvent::PopBack);
    }

    // Add a few more elements
    obs.push_back(100);
    obs.push_front(200);
    expected_events.push(VecDequeEvent::PushBack(100));
    expected_events.push(VecDequeEvent::PushFront(200));

    // Pop remaining elements alternating
    while obs.len() > 1 {
        if obs.len() % 2 == 0 {
            let val = obs.pop_front();
            assert!(val.is_some());
            expected_events.push(VecDequeEvent::PopFront);
        } else {
            let val = obs.pop_back();
            assert!(val.is_some());
            expected_events.push(VecDequeEvent::PopBack);
        }
    }

    // Pop the last element
    if obs.len() > 0 {
        let val = obs.pop_front();
        assert!(val.is_some());
        expected_events.push(VecDequeEvent::PopFront);
    }

    assert_eq!(obs.len(), 0);

    // Verify all events were received correctly
    for expected_event in expected_events {
        let received_event = sub.recv().await.unwrap();
        assert_eq!(received_event, Some(expected_event));
    }

    obs.done();
    assert_eq!(sub.recv().await.unwrap(), Some(VecDequeEvent::Done));
}