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

extern crate alloc;

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

common_def!();

#[test]
fn test_push_one_by_one() {
    let mut buf = get_buf!(Shared);
    let (mut prod, _cons) = buf.split();

    assert_eq!(prod.available(), BUFFER_SIZE - 1);
    for i in 0..BUFFER_SIZE - 1 {
        assert!(prod.push(i).is_ok());
    }
    assert_eq!(prod.available(), 0);
    assert!(prod.push(1).is_err());
}

#[test]
fn test_push_slice() {
    let mut buf = get_buf!(Shared);
    let (mut prod, _cons) = buf.split();

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

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

    assert!(prod.push_slice(&half_slice).is_some());

    assert_eq!(prod.available(), BUFFER_SIZE / 2);

    assert!(prod.push_slice(&slice).is_none());

    assert!(prod.push_slice(&half_slice).is_some());

    assert_eq!(prod.available(), 1);
}

#[test]
#[allow(clippy::unnecessary_cast)]
fn test_push_mut_ref_init() {
    let mut buf = get_buf!(Shared);
    let (mut prod, mut cons) = buf.split();

    assert_eq!(prod.available(), BUFFER_SIZE - 1);
    for i in 0..BUFFER_SIZE - 1 {
        let next = prod.get_next_item_mut_init().unwrap() as *mut usize;

        unsafe {
            next.write(i);
            prod.advance(1);
        }
    }
    assert_eq!(prod.available(), 0);
    assert!(prod.push(1).is_err());

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

#[test]
#[allow(clippy::unnecessary_cast)]
fn test_push_mut_ref() {
    let mut buf = get_buf!(Shared);
    let (mut prod, mut cons) = buf.split();

    assert_eq!(prod.available(), BUFFER_SIZE - 1);
    for i in 0..BUFFER_SIZE - 1 {
        unsafe {
            let next = prod.get_next_item_mut().unwrap() as *mut usize;

            next.write(i);
            prod.advance(1);
        }
    }
    assert_eq!(prod.available(), 0);
    assert!(prod.push(1).is_err());

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