picoring 0.6.0

High-performance, zero-copy circular buffer for Rust using hardware memory mirroring.
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

pub mod buffer;
pub mod collections;
pub mod ring;
pub mod spsc;
pub mod mpsc;
pub mod system;

#[cfg(feature = "python")]
pub mod python;

pub use buffer::MirrorBuffer;
pub use collections::{PicoByteStream, PicoList, PicoQueue};
pub use ring::PicoRing;
pub use spsc::{create_spsc, PicoConsumer, PicoProducer, PicoSPSC};
pub use mpsc::{create_mpsc, PicoMpscConsumer, PicoMpscProducer, PicoMPSC};

#[cfg(feature = "python")]
#[pyo3::prelude::pymodule]
fn picoring(m: &pyo3::prelude::Bound<'_, pyo3::prelude::PyModule>) -> pyo3::prelude::PyResult<()> {
    python::init_module(m)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn it_works() {
        let mut buf = MirrorBuffer::new(4096).unwrap();
        let slice = buf.as_mut_slice();
        slice[0] = 42;
        assert_eq!(slice[4096], 42);
    }

    #[test]
    fn test_alignment() {
        let ps = system::get_page_size();
        assert_eq!(buffer::align_to_page(0), 0);
        assert_eq!(buffer::align_to_page(1), ps);
        assert_eq!(buffer::align_to_page(ps - 1), ps);
        assert_eq!(buffer::align_to_page(ps), ps);
        assert_eq!(buffer::align_to_page(ps + 1), 2 * ps);
        assert_eq!(buffer::align_to_page(2 * ps - 1), 2 * ps);
    }
}