indexed-ring-buffer 0.1.3

An indexed multiple readable spsc ring buffer.
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

extern crate indexed_ring_buffer;

use indexed_ring_buffer::{indexed_ring_buffer, Consumer, Producer, Reader};

#[test]
fn test_minimum() {
    let (mut prod, mut cons, read) = indexed_ring_buffer::<usize>(0, 1);

    assert!(prod.push(0));
    assert_eq!(cons.shift(), Some((0, 0)));
    assert!(prod.push(1));
    assert_eq!(cons.shift(), Some((1, 1)));
    assert!(prod.push(2));
    assert_eq!(cons.shift(), Some((2, 2)));
}

#[test]
fn test_create() {
    let (mut prod, mut cons, read) = indexed_ring_buffer::<usize>(0, 10);
    assert!(prod.is_empty());
    assert!(cons.is_empty());
    assert!(read.is_empty());
    assert!(!prod.is_full());
    assert!(!cons.is_full());
    assert!(!read.is_full());
}

#[test]
fn test_queue() {
    let (mut prod, mut cons, read) = indexed_ring_buffer::<usize>(0, 5);

    assert!(prod.push(0));
    assert!(prod.push(1));
    assert!(prod.push(2));
    assert!(prod.push(3));
    assert!(prod.push(4));

    assert_eq!(read.get(3), Some((3, 3)));
    assert_eq!(read.get_all(), Some((0, 4, [0, 1, 2, 3, 4].to_vec())));
    assert_eq!(read.get_from(1, 3), Some((1, 3, [1, 2, 3].to_vec())));
    assert_eq!(read.get_from(1, 1), Some((1, 1, [1].to_vec())));
    assert_eq!(read.get_from(1, 2), Some((1, 2, [1, 2].to_vec())));
    assert_eq!(read.get_from(1, 4), Some((1, 4, [1, 2, 3, 4].to_vec())));

    assert_eq!(cons.shift_to(3), Some((3_usize, vec![0, 1, 2, 3])));
    assert_eq!(cons.shift_to(13), None);
    assert_eq!(cons.shift(), Some((4, 4)));
    assert_eq!(cons.shift(), None);
}

#[test]
fn test_full_and_empty() {
    let (mut prod, mut cons, read) = indexed_ring_buffer::<usize>(0, 5);

    assert!(prod.push(0));
    assert!(prod.push(1));
    assert!(prod.push(2));
    assert!(prod.push(3));

    assert!(!prod.is_empty());
    assert!(!cons.is_empty());
    assert!(!read.is_empty());
    assert!(!prod.is_full());
    assert!(!cons.is_full());
    assert!(!read.is_full());

    assert!(prod.push(4));

    assert!(prod.is_full());
    assert!(cons.is_full());
    assert!(read.is_full());

    assert_eq!(cons.shift(), Some((0, 0)));

    assert!(!prod.is_full());
    assert!(!cons.is_full());
    assert!(!read.is_full());

    assert_eq!(cons.shift_to(2), Some((2_usize, vec![1, 2])));
    assert_eq!(cons.shift(), Some((3, 3)));
    assert_eq!(cons.shift(), Some((4, 4)));

    assert!(prod.is_empty());
    assert!(cons.is_empty());
    assert!(read.is_empty());
    assert!(!prod.is_full());
    assert!(!cons.is_full());
    assert!(!read.is_full());
}

#[test]
fn test_wrapping_add() {
    let mut n = usize::max_value() - 4;
    let (mut prod, mut cons, read) = indexed_ring_buffer::<usize>(n, 10);

    assert!(prod.push(n));
    n = n.wrapping_add(1);
    assert!(prod.push(n));
    n = n.wrapping_add(1);
    assert!(prod.push(n));
    n = n.wrapping_add(1);
    assert!(prod.push(n));
    n = n.wrapping_add(1);
    assert!(prod.push(n));
    n = n.wrapping_add(1);
    assert!(prod.push(n));
    n = n.wrapping_add(1);
    assert!(prod.push(n));
    n = n.wrapping_add(1);
    assert!(prod.push(n));
    n = n.wrapping_add(1);
    assert!(prod.push(n));
    assert_eq!(
        read.get(18446744073709551611),
        Some((18446744073709551611, 18446744073709551611))
    );
    assert_eq!(
        read.get(18446744073709551612),
        Some((18446744073709551612, 18446744073709551612))
    );
    assert_eq!(
        read.get(18446744073709551613),
        Some((18446744073709551613, 18446744073709551613))
    );
    assert_eq!(
        read.get(18446744073709551614),
        Some((18446744073709551614, 18446744073709551614))
    );
    assert_eq!(
        read.get(18446744073709551615),
        Some((18446744073709551615, 18446744073709551615))
    );

    assert_eq!(read.get(0), Some((0, 0)));
    assert_eq!(read.get(1), Some((1, 1)));
    assert_eq!(read.get(2), Some((2, 2)));
    assert_eq!(read.get(3), Some((3, 3)));
}