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

//! The SPSC-Queue is a Single-Producer Single-Consumer Queue
//!
//! # Bounded
//! The Bounded-Queue is currently the fastest Queue available in this crate
//! and should be the preferred Queue to use. However the major drawback is the
//! fact, that it is bounded and can therefore only hold a limited number of
//! items at a time.
//!
//! # Unbounded
//! The Unbounded-Queue is still really fast and will most likely be fast
//! enough for most use-cases, however since this Queue is unbounded it has
//! a broader range of applications as it can "grow" as needed without
//! having to sacrifice a lot of performance.

/// The Error for the Dequeue Operation
#[derive(Debug, PartialEq)]
pub enum DequeueError {
    /// This indicates that no Data could be dequeued
    WouldBlock,
    /// This indicates that the Queue is empty and the other side of the
    /// Queue has been dropped, meaning that no more Items can be added to the
    /// Queue either
    Closed,
}

/// The Error for the Enqueue Operation
#[derive(Debug, PartialEq)]
pub enum EnqueueError {
    /// This means that the Queue is full and the Element could not be
    /// inserted in this Moment
    WouldBlock,
    /// This indicates that the Queue is empty and the other side of the
    /// Queue has been dropped, meaning that no more Items can be added to the
    /// Queue either
    Closed,
}

pub mod bounded;

pub mod unbounded;