oneringbuf 0.7.0

A lock-free single-producer, single-consumer (SPSC) ring buffer with in-place mutability, asynchronous support, and virtual memory optimisation.
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

extern crate alloc;

use crate::{common_def, get_buf};
use oneringbuf::ORBIterator;

common_def!();

#[test]
fn test_push_work_pop_single() {
    let mut buf = get_buf!(SharedMut);
    let (mut prod, mut work, mut cons) = buf.split_mut();

    assert_eq!(prod.available(), BUFFER_SIZE - 1);
    assert_eq!(work.available(), 0);
    assert_eq!(cons.available(), 0);

    for i in 0..BUFFER_SIZE - 1 {
        let _ = prod.push(i);
    }
    assert_eq!(prod.available(), 0);
    assert_eq!(work.available(), BUFFER_SIZE - 1);
    assert_eq!(cons.available(), 0);

    for _ in 0..BUFFER_SIZE - 1 {
        if let Some(data) = work.get_mut() {
            *data += 1;
            unsafe { work.advance(1) };
        }
    }
    assert_eq!(prod.available(), 0);
    assert_eq!(work.available(), 0);
    assert_eq!(cons.available(), BUFFER_SIZE - 1);

    for i in 0..BUFFER_SIZE - 1 {
        assert_eq!(cons.pop().unwrap(), i + 1);
    }

    assert_eq!(prod.available(), BUFFER_SIZE - 1);
    assert_eq!(work.available(), 0);
    assert_eq!(cons.available(), 0);
}

#[test]
fn test_push_work_pop_slice() {
    let mut buf = get_buf!(SharedMut);
    let (mut prod, mut work, mut cons) = buf.split_mut();

    let slice = (0..BUFFER_SIZE - 1).collect::<Vec<usize>>();

    assert_eq!(prod.available(), BUFFER_SIZE - 1);
    assert_eq!(work.available(), 0);
    assert_eq!(cons.available(), 0);

    prod.push_slice(&slice);

    assert_eq!(prod.available(), 0);
    assert_eq!(work.available(), BUFFER_SIZE - 1);
    assert_eq!(cons.available(), 0);

    #[cfg(not(all(feature = "vmem", unix)))]
    if let Some((h, t)) = work.get_mut_slice_exact(BUFFER_SIZE - 1) {
        for i in h.iter_mut().chain(t) {
            *i += 1;
        }
        unsafe { work.advance(BUFFER_SIZE - 1) };
    }
    #[cfg(all(feature = "vmem", unix))]
    if let Some(s) = work.get_mut_slice_exact(BUFFER_SIZE - 1) {
        for i in s {
            *i += 1;
        }
        unsafe { work.advance(BUFFER_SIZE - 1) };
    }

    assert_eq!(prod.available(), 0);
    assert_eq!(work.available(), 0);
    assert_eq!(cons.available(), BUFFER_SIZE - 1);

    #[cfg(not(all(feature = "vmem", unix)))]
    if let Some((h, t)) = cons.peek_slice(BUFFER_SIZE - 1) {
        for (consumed, i) in [h, t].concat().iter().zip(slice) {
            assert_eq!(*consumed, i + 1);
        }
    }
    #[cfg(all(feature = "vmem", unix))]
    if let Some(s) = cons.peek_slice(BUFFER_SIZE - 1) {
        for (consumed, i) in s.iter().zip(slice) {
            assert_eq!(*consumed, i + 1);
        }
    }

    unsafe { cons.advance(BUFFER_SIZE - 1) };

    assert_eq!(prod.available(), BUFFER_SIZE - 1);
    assert_eq!(work.available(), 0);
    assert_eq!(cons.available(), 0);
}

#[test]
fn test_reset() {
    let mut buf = get_buf!(SharedMut);
    let (mut prod, mut work, mut cons) = buf.split_mut();

    let two_thirds_slice = (0..BUFFER_SIZE / 3 * 2).collect::<Vec<usize>>();
    let slice = (0..BUFFER_SIZE - 1).collect::<Vec<usize>>();

    assert_eq!(prod.available(), BUFFER_SIZE - 1);
    assert_eq!(work.available(), 0);
    assert_eq!(cons.available(), 0);

    prod.push_slice(&two_thirds_slice);

    assert_eq!(prod.available(), BUFFER_SIZE / 3);
    assert_eq!(work.available(), BUFFER_SIZE / 3 * 2);
    assert_eq!(cons.available(), 0);

    unsafe { work.advance(BUFFER_SIZE / 3) };

    assert_eq!(prod.available(), BUFFER_SIZE / 3);
    assert_eq!(work.available(), BUFFER_SIZE / 3);
    assert_eq!(cons.available(), BUFFER_SIZE / 3);

    work.reset_index();

    assert_eq!(prod.available(), BUFFER_SIZE / 3);
    assert_eq!(work.available(), 0);
    assert_eq!(cons.available(), BUFFER_SIZE / 3 * 2);

    cons.reset_index();

    assert_eq!(prod.available(), BUFFER_SIZE - 1);
    assert_eq!(work.available(), 0);
    assert_eq!(cons.available(), 0);

    prod.push_slice(&slice);

    assert_eq!(prod.available(), 0);
    assert_eq!(work.available(), BUFFER_SIZE - 1);
    assert_eq!(cons.available(), 0);

    work.reset_index();

    assert_eq!(prod.available(), 0);
    assert_eq!(work.available(), 0);
    assert_eq!(cons.available(), BUFFER_SIZE - 1);
}