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

#![cfg(feature = "alloc")]

use alloc::boxed::Box;
use core::ops::Deref;
use core::ptr::NonNull;

use crate::ring_buffer::{OneRB, iters_components::PIterComponent, wrappers::refs::BufRef};

pub struct DroppableRef<B: OneRB> {
    inner: NonNull<B>,
}

impl<B: OneRB> From<B> for DroppableRef<B> {
    fn from(value: B) -> Self {
        let x = Box::new(value);

        Self {
            inner: NonNull::new(Box::into_raw(x)).unwrap(),
        }
    }
}

impl<B: OneRB> DroppableRef<B> {
    #[inline(never)]
    fn try_drop(&mut self) {
        unsafe {
            let _ = Box::from_raw(self.inner.as_ptr());
        }
    }
}

impl<B: OneRB> Clone for DroppableRef<B> {
    fn clone(&self) -> Self {
        Self { inner: self.inner }
    }
}

impl<B: OneRB> Deref for DroppableRef<B> {
    type Target = B;

    fn deref(&self) -> &Self::Target {
        unsafe { self.inner.as_ref() }
    }
}

impl<B: OneRB> Drop for DroppableRef<B> {
    fn drop(&mut self) {
        if unsafe { self.inner.as_ref().iters().drop_iter() } != 1 {
            return;
        }

        self.iters().acquire_fence();

        self.try_drop();
    }
}

impl<B: OneRB> BufRef for DroppableRef<B> {
    type Buffer = B;
}