tokio_delayed_queue 0.2.0

Asynchronous delayed queue for Tokio runtime.
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

// #![doc = include_str!("../README.md")]

/// # Tokio delayed queue
///
/// Asyncronous delayed queue for Tokio runtime.
///
/// # Features
///
/// - multi-consume
/// - multi-produce
/// - fixed queue size
/// - atomic pop with pop-future cancelation
///
/// ```rust
/// # use tokio_delayed_queue::DelayedQueue;
/// # use std::{time::Duration, num::NonZeroUsize};
/// # tokio_test::block_on(async {
///
/// let queue = DelayedQueue::new_bound(NonZeroUsize::new(16).unwrap());
///
/// // Push
/// queue.push(1, Duration::from_secs(1)).await;
/// queue.push(1, Duration::from_secs(2)).await;
///
/// // Pop
/// let v = queue.pop().await;
/// assert_eq!(v, 1);
///
/// // Other future
/// let join = tokio::spawn({
///     let queue = queue.clone();
///     async move {
///         // Cancelled 1
///         let dropped_future = queue.pop();
///         drop(dropped_future);
///
///         // Cancelled 2
///         let dropped_future = queue.pop();
///         drop(dropped_future);
///
///         // Pop
///         let v = queue.pop().await;
///         assert_eq!(v, 1);
///
///         // Pop
///         let v = queue.pop().await;
///         assert_eq!(v, 1);
///     }
/// });
///
/// // Push
/// queue.push(1, Duration::from_secs(2)).await;
///
/// join.await.unwrap();
///
/// # });
/// ```
////////////////////////////////////////////////////////////////////////////////////////////////////
mod future;
mod item;
mod queue;
mod reserve;
mod sleep;

////////////////////////////////////////////////////////////////////////////////////////////////////

pub use self::{future::DelayedPopFuture, queue::DelayedQueue};