bbqueue 0.6.2

A SPSC, lockless, no_std, thread safe, queue, based on BipBuffers
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

//! BBQueue Styles: Sixteen great flavors!
//!
//! | Storage | Coordination     | Notifier | Arc?   | Nickname     | Source        |
//! | :---    | :---             | :---     | :---   | :---         | :---          |
//! | Inline  | Critical Section | Polling  | No     | Jerk         | Jamaica       |
//! | Inline  | Critical Section | Polling  | Yes    | Asado        | Argentina     |
//! | Inline  | Critical Section | Async    | No     | Memphis      | USA           |
//! | Inline  | Critical Section | Async    | Yes    | Carolina     | USA           |
//! | Inline  | Atomic           | Polling  | No     | Churrasco    | Brazil        |
//! | Inline  | Atomic           | Polling  | Yes    | Barbacoa     | Mexico        |
//! | Inline  | Atomic           | Async    | No     | Texas        | USA           |
//! | Inline  | Atomic           | Async    | Yes    | KansasCity   | USA           |
//! | Heap    | Critical Section | Polling  | No     | Braai        | South Africa  |
//! | Heap    | Critical Section | Polling  | Yes    | Kebab        | Türkiye       |
//! | Heap    | Critical Section | Async    | No     | SiuMei       | Hong Kong     |
//! | Heap    | Critical Section | Async    | Yes    | Satay        | SE Asia       |
//! | Heap    | Atomic           | Polling  | No     | YakiNiku     | Japan         |
//! | Heap    | Atomic           | Polling  | Yes    | GogiGui      | South Korea   |
//! | Heap    | Atomic           | Async    | No     | Tandoori     | India         |
//! | Heap    | Atomic           | Async    | Yes    | Lechon       | Philippines   |

#![allow(unused_imports)]

#[cfg(feature = "alloc")]
use crate::queue::ArcBBQueue;
#[cfg(target_has_atomic = "ptr")]
use crate::traits::coordination::cas::AtomicCoord;
#[cfg(feature = "critical-section")]
use crate::traits::coordination::cs::CsCoord;
#[cfg(feature = "alloc")]
use crate::traits::storage::BoxedSlice;
use crate::{
    BBQueue,
    traits::{notifier::polling::Polling, storage::Inline},
};

/// Inline Storage, Critical Section, Polling, Borrowed
#[cfg(feature = "critical-section")]
pub type Jerk<const N: usize> = BBQueue<Inline<N>, CsCoord, Polling>;

/// Inline Storage, Critical Section, Async, Borrowed
#[cfg(feature = "critical-section")]
pub type Memphis<const N: usize, A> = BBQueue<Inline<N>, CsCoord, A>;

/// Inline Storage, Atomics, Polling, Borrowed
#[cfg(target_has_atomic = "ptr")]
pub type Churrasco<const N: usize> = BBQueue<Inline<N>, AtomicCoord, Polling>;

/// Inline Storage, Atomics, Async, Borrowed
#[cfg(target_has_atomic = "ptr")]
pub type Texas<const N: usize, A> = BBQueue<Inline<N>, AtomicCoord, A>;

/// Heap Buffer, Critical Section, Polling, Borrowed
#[cfg(all(feature = "alloc", feature = "critical-section"))]
pub type Braai = BBQueue<BoxedSlice, CsCoord, Polling>;

/// Heap Buffer, Critical Section, Async, Borrowed
#[cfg(all(feature = "alloc", feature = "critical-section"))]
pub type SiuMei<A> = BBQueue<BoxedSlice, CsCoord, A>;

/// Heap Buffer, Atomics, Polling, Borrowed
#[cfg(all(feature = "alloc", target_has_atomic = "ptr"))]
pub type YakiNiku = BBQueue<BoxedSlice, AtomicCoord, Polling>;

/// Heap Buffer, Atomics, Async, Borrowed
#[cfg(all(feature = "alloc", target_has_atomic = "ptr"))]
pub type Tandoori<A> = BBQueue<BoxedSlice, AtomicCoord, A>;

/// Inline Storage, Critical Section, Polling, Arc
#[cfg(all(feature = "alloc", feature = "critical-section"))]
pub type Asado<const N: usize> = ArcBBQueue<Inline<N>, CsCoord, Polling>;

/// Inline Storage, Critical Section, Async, Arc
#[cfg(all(feature = "alloc", feature = "critical-section"))]
pub type Carolina<const N: usize, A> = ArcBBQueue<Inline<N>, CsCoord, A>;

/// Inline Storage, Atomics, Polling, Arc
#[cfg(all(feature = "alloc", target_has_atomic = "ptr"))]
pub type Barbacoa<const N: usize> = ArcBBQueue<Inline<N>, AtomicCoord, Polling>;

/// Inline Storage, Atomics, Async, Arc
#[cfg(all(feature = "alloc", target_has_atomic = "ptr"))]
pub type KansasCity<const N: usize, A> = ArcBBQueue<Inline<N>, AtomicCoord, A>;

/// Heap Buffer, Critical Section, Polling, Arc
#[cfg(all(feature = "alloc", feature = "critical-section"))]
pub type Kebab = ArcBBQueue<BoxedSlice, CsCoord, Polling>;

/// Heap Buffer, Critical Section, Async, Arc
#[cfg(all(feature = "alloc", feature = "critical-section"))]
pub type Satay<A> = ArcBBQueue<BoxedSlice, CsCoord, A>;

/// Heap Buffer, Atomics, Polling, Arc
#[cfg(all(feature = "alloc", target_has_atomic = "ptr"))]
pub type GogiGui = ArcBBQueue<BoxedSlice, AtomicCoord, Polling>;

/// Heap Buffer, Atomics, Async, Arc
#[cfg(all(feature = "alloc", target_has_atomic = "ptr"))]
pub type Lechon<A> = ArcBBQueue<BoxedSlice, AtomicCoord, A>;