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

#![allow(unused_mut)]

pub mod async_tests;
pub mod common;
pub mod sync_tests;

#[cfg(all(feature = "vmem", unix))]
macro_rules! common_def {
    () => {
        #[cfg(target_arch = "aarch64")]
        const BUFFER_SIZE: usize = 16384;
        #[cfg(not(target_arch = "aarch64"))]
        const BUFFER_SIZE: usize = 4096;
    };
}
#[cfg(not(all(feature = "vmem", unix)))]
macro_rules! common_def {
    () => {
        const BUFFER_SIZE: usize = 400;
    };
}

#[cfg(all(feature = "alloc", feature = "vmem", unix))]
macro_rules! get_buf {
    (Local) => {
        oneringbuf::LocalVmemRB::from(vec![0; BUFFER_SIZE])
    };
    (LocalMut) => {
        oneringbuf::LocalVmemRBMut::from(vec![0; BUFFER_SIZE])
    };
    (Shared) => {
        oneringbuf::SharedVmemRB::from(vec![0; BUFFER_SIZE])
    };
    (SharedMut) => {
        oneringbuf::SharedVmemRBMut::from(vec![0; BUFFER_SIZE])
    };
}
#[cfg(all(feature = "alloc", not(all(feature = "vmem", unix))))]
macro_rules! get_buf {
    (Local) => {
        oneringbuf::LocalHeapRB::from(vec![0; BUFFER_SIZE])
    };
    (LocalMut) => {
        oneringbuf::LocalHeapRBMut::from(vec![0; BUFFER_SIZE])
    };
    (Shared) => {
        oneringbuf::SharedHeapRB::from(vec![0; BUFFER_SIZE])
    };
    (SharedMut) => {
        oneringbuf::SharedHeapRBMut::from(vec![0; BUFFER_SIZE])
    };
}
#[cfg(all(not(feature = "alloc"), not(all(feature = "vmem", unix))))]
macro_rules! get_buf {
    (Local) => {
        oneringbuf::LocalStackRB::from([0; BUFFER_SIZE])
    };
    (LocalMut) => {
        oneringbuf::LocalStackRBMut::from([0; BUFFER_SIZE])
    };
    (Shared) => {
        oneringbuf::SharedStackRB::from([0; BUFFER_SIZE])
    };
    (SharedMut) => {
        oneringbuf::SharedStackRBMut::from([0; BUFFER_SIZE])
    };
}
pub(crate) use {common_def, get_buf};

#[cfg(feature = "alloc")]
#[test]
#[should_panic]
fn len_zero_heap() {
    let _ = oneringbuf::SharedHeapRB::<i32>::default(0);
}

#[cfg(all(feature = "alloc", feature = "vmem", unix))]
#[test]
#[should_panic]
fn len_zero_vmem() {
    let _ = oneringbuf::SharedVmemRB::<i32>::default(0);
}

#[cfg(not(all(feature = "vmem", unix)))]
#[test]
#[should_panic]
fn len_zero_stack() {
    let _ = oneringbuf::SharedStackRB::<i32, 0>::default();
}