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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

#[cfg(feature = "alloc")]
use crate::{
    ring_buffer::wrappers::refs::droppable::DroppableRef, storage_components::HeapStorage,
};

#[cfg(all(feature = "alloc", feature = "vmem", unix))]
use crate::storage_components::VmemStorage;

use crate::{
    OneRingBuf,
    iterators::{ConsIter, ProdIter, WorkIter},
    iters_components::{MutIterComp, NonMutIterComp},
    ring_buffer::{
        iters_components::IterComponent,
        wrappers::refs::{IntoRef, non_droppable::NonDroppableRef},
    },
    storage_components::StackStorage,
};

impl<'buf, T, const N: usize, I: IterComponent> IntoRef
    for OneRingBuf<StackStorage<'buf, T, N>, I>
{
    type TargetRef = NonDroppableRef<Self>;

    fn into_ref(mut s: Self) -> Self::TargetRef {
        NonDroppableRef::from(&mut s)
    }
}

impl<'buf, T, const N: usize, I: NonMutIterComp> OneRingBuf<StackStorage<'buf, T, N>, I> {
    /// Returns two iterators: a Producer and a Consumer.
    /// <div class="warning">Available only for non-mutable buffers.</div>
    pub fn split(
        &'buf mut self,
    ) -> (
        ProdIter<OneRingBuf<StackStorage<'buf, T, N>, I>>,
        ConsIter<OneRingBuf<StackStorage<'buf, T, N>, I>>,
    ) {
        let r = NonDroppableRef::from(self);
        (ProdIter::new(r.clone()), ConsIter::new(r))
    }
}
impl<'buf, T, const N: usize, I: MutIterComp> OneRingBuf<StackStorage<'buf, T, N>, I> {
    /// Returns three iterators: a Producer, a Worker and a Consumer.
    /// <div class="warning">Available only for mutable buffers.</div>
    pub fn split_mut(
        &'buf mut self,
    ) -> (
        ProdIter<OneRingBuf<StackStorage<'buf, T, N>, I>>,
        WorkIter<OneRingBuf<StackStorage<'buf, T, N>, I>>,
        ConsIter<OneRingBuf<StackStorage<'buf, T, N>, I>>,
    ) {
        let r = NonDroppableRef::from(self);
        (
            ProdIter::new(r.clone()),
            WorkIter::new(r.clone()),
            ConsIter::new(r),
        )
    }
}

#[cfg(feature = "alloc")]
impl<T, I: IterComponent> IntoRef for OneRingBuf<HeapStorage<T>, I> {
    type TargetRef = DroppableRef<Self>;

    fn into_ref(s: Self) -> Self::TargetRef {
        DroppableRef::from(s)
    }
}

#[cfg(feature = "alloc")]
impl<T, I: NonMutIterComp> OneRingBuf<HeapStorage<T>, I> {
    /// Returns two iterators: a Producer and a Consumer.
    /// <div class="warning">Available only for non-mutable buffers.</div>
    pub fn split(
        self,
    ) -> (
        ProdIter<OneRingBuf<HeapStorage<T>, I>>,
        ConsIter<OneRingBuf<HeapStorage<T>, I>>,
    ) {
        let r = DroppableRef::from(self);
        (ProdIter::new(r.clone()), ConsIter::new(r))
    }
}
#[cfg(feature = "alloc")]
impl<T, I: MutIterComp> OneRingBuf<HeapStorage<T>, I> {
    /// Returns three iterators: a Producer, a Worker and a Consumer.
    /// <div class="warning">Available only for mutable buffers.</div>
    pub fn split_mut(
        self,
    ) -> (
        ProdIter<OneRingBuf<HeapStorage<T>, I>>,
        WorkIter<OneRingBuf<HeapStorage<T>, I>>,
        ConsIter<OneRingBuf<HeapStorage<T>, I>>,
    ) {
        let r = DroppableRef::from(self);
        (
            ProdIter::new(r.clone()),
            WorkIter::new(r.clone()),
            ConsIter::new(r),
        )
    }
}

#[cfg(all(feature = "alloc", feature = "vmem", unix))]
impl<T, I: IterComponent> IntoRef for OneRingBuf<VmemStorage<T>, I> {
    type TargetRef = DroppableRef<Self>;

    fn into_ref(s: Self) -> Self::TargetRef {
        DroppableRef::from(s)
    }
}

#[cfg(all(feature = "alloc", feature = "vmem", unix))]
impl<T, I: NonMutIterComp> OneRingBuf<VmemStorage<T>, I> {
    /// Returns two iterators: a Producer and a Consumer.
    /// <div class="warning">Available only for non-mutable buffers.</div>
    pub fn split(
        self,
    ) -> (
        ProdIter<OneRingBuf<VmemStorage<T>, I>>,
        ConsIter<OneRingBuf<VmemStorage<T>, I>>,
    ) {
        let r = DroppableRef::from(self);
        (ProdIter::new(r.clone()), ConsIter::new(r))
    }
}
#[cfg(all(feature = "alloc", feature = "vmem", unix))]
impl<T, I: MutIterComp> OneRingBuf<VmemStorage<T>, I> {
    /// Returns three iterators: a Producer, a Worker and a Consumer.
    /// <div class="warning">Available only for mutable buffers.</div>
    pub fn split_mut(
        self,
    ) -> (
        ProdIter<OneRingBuf<VmemStorage<T>, I>>,
        WorkIter<OneRingBuf<VmemStorage<T>, I>>,
        ConsIter<OneRingBuf<VmemStorage<T>, I>>,
    ) {
        let r = DroppableRef::from(self);
        (
            ProdIter::new(r.clone()),
            WorkIter::new(r.clone()),
            ConsIter::new(r),
        )
    }
}