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

//! Components used by the buffers to store data.

use crate::utils::UnsafeSyncCell;

#[cfg(feature = "alloc")]
pub use alloc::heap::HeapStorage;
#[cfg(all(feature = "alloc", feature = "vmem", unix))]
pub use alloc::vmem::VmemStorage;
pub use stack::StackStorage;

pub(crate) mod alloc;
pub(crate) mod stack;

/// Trait implemented by `*Storage` structs.
#[allow(clippy::len_without_is_empty)]
pub(crate) trait PStorageComponent: StorageComponent {
    fn _index(&self, index: usize) -> &UnsafeSyncCell<Self::Item>;

    /// Returns the length of the underlying array.
    fn len(&self) -> usize;

    /// Returns the next chunk long `count` which starts from `index`.
    fn next_chunk<'a>(&self, index: usize, count: usize) -> Self::SliceOutput<'a>;
    /// Returns the next mutable chunk long `count` which starts from `index`.
    fn next_chunk_mut<'a>(&mut self, index: usize, count: usize) -> Self::SliceOutputMut<'a>;

    fn _push_slice(
        &mut self,
        index: usize,
        slice: &[Self::Item],
        f: fn(&mut [Self::Item], &[Self::Item]),
    );

    fn _extract_slice(
        &mut self,
        index: usize,
        dst: &mut [Self::Item],
        f: fn(&[Self::Item], &mut [Self::Item]),
    );
}

/// Trait implemented by storage components.
pub trait StorageComponent {
    /// Type stored in the storage.
    type Item;

    /// Type used when working with non-mutable slices.
    type SliceOutput<'a>
    where
        Self::Item: 'a;

    /// Type used when working with non-mutable slices.
    type SliceOutputMut<'a>
    where
        Self::Item: 'a;
}