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

use core::cell::UnsafeCell;

#[cfg(feature = "async")]
use crate::iters_components::async_iters::{mutable::AsyncCompMut, non_mutable::AsyncComp};
use crate::{
    iters_components::shared_iters::{mutable::SharedCompMut, non_mutable::SharedComp},
    ring_buffer::{iters_components::IterComponent, storage_components::PStorageComponent},
};

pub mod impls;
pub mod iters_components;
pub mod storage_components;
pub mod types;
pub mod wrappers;

/// Trait implemented by concurrent ring buffer.
pub(crate) trait SharedRB {}

impl<S: PStorageComponent> SharedRB for OneRingBuf<S, SharedComp> {}
impl<S: PStorageComponent> SharedRB for OneRingBuf<S, SharedCompMut> {}
#[cfg(feature = "async")]
impl<S: PStorageComponent> SharedRB for OneRingBuf<S, AsyncComp> {}
#[cfg(feature = "async")]
impl<S: PStorageComponent> SharedRB for OneRingBuf<S, AsyncCompMut> {}

/// Trait implemented by ring buffers.
///
/// This trait provides the core functionality for all ring buffer types in this crate.
/// It defines the associated types for the item, storage, and iterators, and provides
/// methods to access the storage and iterators, and to get the length of the buffer.
pub trait OneRB {
    /// The type of items stored in the ring buffer.
    type Item;
    /// The storage component for the ring buffer.
    type Storage: PStorageComponent<Item = Self::Item>;
    /// The iterator component for the ring buffer.
    type Iters: IterComponent;

    /// Returns a reference to the iterator component.
    fn iters(&self) -> &Self::Iters;
    /// Returns a reference to the storage component.
    fn storage(&self) -> &Self::Storage;
    /// Returns a mutable reference to the storage component.
    fn storage_mut(&self) -> &mut Self::Storage;
    /// Returns the length of the buffer.
    fn len(&self) -> usize;
}

/// The One Ring aka the main struct of this crate.
/// All the other buffers are based upon this.
pub struct OneRingBuf<S: PStorageComponent, I: IterComponent> {
    pub(crate) inner: UnsafeCell<S>,
    pub(crate) iters: I,
}

impl<S: PStorageComponent, I: IterComponent> OneRB for OneRingBuf<S, I> {
    type Item = S::Item;
    type Storage = S;
    type Iters = I;

    #[inline]
    fn iters(&self) -> &Self::Iters {
        &self.iters
    }

    #[inline]
    fn storage(&self) -> &Self::Storage {
        unsafe { &*self.inner.get() }
    }

    #[inline]
    fn storage_mut(&self) -> &mut Self::Storage {
        unsafe { &mut *self.inner.get() }
    }

    #[inline]
    fn len(&self) -> usize {
        self.storage().len()
    }
}

impl<S: PStorageComponent, I: IterComponent> OneRingBuf<S, I> {
    pub(crate) const fn _from(value: S, iters: I) -> Self {
        Self {
            inner: UnsafeCell::new(value),
            iters: iters,
        }
    }
}