rivulet 0.1.0

Asynchronous contiguous-memory streams
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

use rivulet::{
    slice::{Slice, SliceMut},
    SplittableView, View, ViewMut,
};

#[test]
fn slice() {
    let storage: Vec<u8> = (0..100).collect();
    let mut stream = Slice::new(&storage).into_view();

    // There should be an immediate view available
    stream.blocking_grant(0).unwrap();
    let view = stream.view();
    assert_eq!(view.len(), 100);
    assert_eq!(view[0], 0);

    // Request a grant, nothing should change
    stream.blocking_grant(10).unwrap();
    let view = stream.view();
    assert_eq!(view.len(), 100);
    assert_eq!(view[0], 0);

    // Release a few items and change a value
    stream.release(5);
    let view = stream.view();
    assert_eq!(view.len(), 95);
    assert_eq!(view[0], 5);

    // Do a giant (but useless) grant request and release the remaining items except one
    stream.blocking_grant(1000).unwrap();
    stream.release(94);
    let view = stream.view();
    assert_eq!(view.len(), 1);
    assert_eq!(view[0], 99);

    // Release the last item
    stream.release(1);
    let view = stream.view();
    assert!(view.is_empty());
}

#[test]
fn slice_mut() {
    let mut storage: Vec<u8> = (0..100).collect();
    let mut stream = SliceMut::new(&mut storage).into_view();

    // There should be an immediate view available
    stream.blocking_grant(0).unwrap();
    let view = stream.view();
    assert_eq!(view.len(), 100);
    assert_eq!(view[0], 0);

    // Request a grant, nothing should change
    stream.blocking_grant(10).unwrap();
    let view = stream.view();
    assert_eq!(view.len(), 100);
    assert_eq!(view[0], 0);

    // Release a few items and change a value
    stream.release(5);
    let view = stream.view_mut();
    assert_eq!(view.len(), 95);
    assert_eq!(view[0], 5);
    view[0] = 101;

    // Do a giant (but useless) grant request and release the remaining items except one
    stream.blocking_grant(1000).unwrap();
    stream.release(94);
    let view = stream.view();
    assert_eq!(view.len(), 1);
    assert_eq!(view[0], 99);

    // Release the last item
    stream.release(1);
    let view = stream.view();
    assert!(view.is_empty());

    // Check that the storage contains the original with the modification
    let expected = {
        let mut expected: Vec<u8> = (0..100).collect();
        expected[5] = 101;
        expected
    };
    assert_eq!(storage, expected);
}

#[test]
#[should_panic]
fn bad_release() {
    let storage: Vec<u8> = (0..100).collect();
    let mut stream = Slice::new(&storage).into_view();
    stream.release(101);
}