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

#![cfg_attr(doc, feature(doc_cfg))]
#![doc = include_str!("../README.md")]
#![no_std]
#![allow(private_bounds, private_interfaces)]

#[cfg(feature = "alloc")]
extern crate alloc;

#[doc(inline)]
pub use iterators::ORBIterator;

pub use crate::ring_buffer::iters_components::IterComponent;
pub use crate::ring_buffer::storage_components::StorageComponent;
pub use crate::ring_buffer::{OneRB, OneRingBuf};
pub use ring_buffer::wrappers::refs::IntoRef;

// AsyncStackRB
#[cfg(any(feature = "async", doc))]
pub use crate::ring_buffer::types::{AsyncStackRB, AsyncStackRBMut};

// AsyncHeapRB
#[cfg(all(feature = "alloc", feature = "async"))]
pub use crate::ring_buffer::types::{AsyncHeapRB, AsyncHeapRBMut};

// AsyncHeapRB
#[cfg(all(feature = "alloc", feature = "async", feature = "vmem", unix))]
pub use crate::ring_buffer::types::{AsyncVmemRB, AsyncVmemRBMut};

// Heap
#[cfg(feature = "alloc")]
pub use crate::ring_buffer::types::{LocalHeapRB, LocalHeapRBMut, SharedHeapRB, SharedHeapRBMut};

// Vmem
#[cfg(any(doc, all(feature = "alloc", feature = "vmem", unix)))]
pub use crate::ring_buffer::types::{LocalVmemRB, LocalVmemRBMut, SharedVmemRB, SharedVmemRBMut};

// Stack
pub use crate::ring_buffer::types::{
    LocalStackRB, LocalStackRBMut, SharedStackRB, SharedStackRBMut,
};

pub use ring_buffer::iters_components;
pub use ring_buffer::storage_components;

pub mod iterators;
mod ring_buffer;

/// Various utilities
pub mod utils {
    pub use crate::ring_buffer::wrappers::unsafe_sync_cell::UnsafeSyncCell;
    #[cfg(all(feature = "alloc", feature = "vmem", unix))]
    pub use crate::storage_components::alloc::vmem::vmem_helper;
}