ringbuf 0.6.0

Lock-free SPSC FIFO ring buffer with direct access to inner data
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

use crate::traits::RingBuffer;
#[cfg(feature = "alloc")]
use {crate::alias::Arc, alloc::rc::Rc};

/// Abstract pointer to the owning ring buffer.
///
/// # Safety
///
/// Every access through `rb`, including through cloned handles, must refer to
/// the same live backing buffer. The buffer must outlive every reference returned
/// from a handle. A handle does not itself grant producer or consumer rights.
/// The default `rb` implementation requires `as_ref` to preserve this identity.
pub unsafe trait RbRef: Clone + AsRef<Self::Rb> {
    /// Underlying ring buffer.
    type Rb: RingBuffer + ?Sized;
    /// Get ring buffer reference.
    fn rb(&self) -> &Self::Rb {
        self.as_ref()
    }
}

unsafe impl<B: RingBuffer + AsRef<B> + ?Sized> RbRef for &B {
    type Rb = B;
    fn rb(&self) -> &B {
        // AsRef is safe to implement and may select a different buffer on each
        // call. A borrowed handle must always use the object it points to.
        self
    }
}
#[cfg(feature = "alloc")]
unsafe impl<B: RingBuffer + ?Sized> RbRef for Rc<B> {
    type Rb = B;
}
#[cfg(feature = "alloc")]
unsafe impl<B: RingBuffer + ?Sized> RbRef for Arc<B> {
    type Rb = B;
}