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

#![cfg(any(feature = "async", doc))]

use core::task::Waker;

use crate::IterComponent;

pub mod mutable;
pub mod non_mutable;

/// Trait implemented by async iterator components.
///
/// This trait is not meant to be implemented outside of this crate, nor
/// are its methods meant to be called directly.
/// Instead, this trait should be used only as parameter/bound.
pub trait AsyncIterComp: IterComponent {
    fn wake_middle_iter(&self);

    fn register_prod_waker(&self, waker: &Waker);
    fn take_prod_waker(&self) -> Option<Waker>;
    fn wake_prod(&self);

    fn register_work_waker(&self, waker: &Waker);
    fn take_work_waker(&self) -> Option<Waker>;
    fn wake_work(&self);

    fn register_cons_waker(&self, waker: &Waker);
    fn take_cons_waker(&self) -> Option<Waker>;
    fn wake_cons(&self);
}