aqueue 1.4.2

fast speed thread safe async execute queue.
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179

//! # aqueue — Fast, Thread-Safe Async Execution Queue
//!
//! `aqueue` provides three concurrency models for protecting shared state in
//! async Rust code, each backed by a different locking primitive:
//!
//! | Type | Primitive | Best for |
//! |---|---|---|
//! | [`Actor<I>`] | Mutex | serial / write-heavy workloads |
//! | [`RwModel<I>`] | RwLock | read-heavy workloads |
//! | [`PCModel<I>`] | Semaphore | bounded parallelism / rate limiting |
//!
//! The low-level queue primitives ([`AQueue`], [`RwQueue`], [`SemaphoreQueue`])
//! are also exported for custom use cases.
//!
//! ## Feature flags
//!
//! | Flag | Effect |
//! |---|---|
//! | `tokio_time` | Enables [`inner_wait!`], [`call_wait!`], [`call_mut_wait!`] with tokio timeouts |
//! | `async_std_time` | Same macros backed by async-std timeouts |

mod actor;
mod inner_store;
mod mutex;
mod pc_model;
mod rw_model;
mod rwlock;
mod semaphore;

pub use actor::Actor;
pub use mutex::AQueue;
pub use pc_model::PCModel;
pub use rw_model::RwModel;
pub use rwlock::RwQueue;
pub use semaphore::SemaphoreQueue;

/// Run [`Actor::inner_call`] with a millisecond timeout, returning
/// `Err` if the deadline is exceeded.
///
/// Requires the `tokio_time` feature.
///
/// ```toml
/// aqueue = { version = "^1.4", features = ["tokio_time"] }
/// ```
///
/// # Example
///
/// ```ignore
/// let result = inner_wait!(actor, 5000, |inner| async move {
///     inner.get_mut().do_work()
/// }).await?;
/// ```
#[cfg(all(feature = "tokio_time", not(feature = "async_std_time")))]
#[macro_export]
macro_rules! inner_wait {
    ($actor:expr,$timeout:expr,$fun:expr) => {
        tokio::time::timeout(std::time::Duration::from_millis($timeout), $actor.inner_call($fun))
    };
}

/// Run [`Actor::inner_call`] with a millisecond timeout, returning
/// `Err` if the deadline is exceeded.
///
/// Requires the `async_std_time` feature.
///
/// ```toml
/// aqueue = { version = "^1.4", features = ["async_std_time"] }
/// ```
///
/// # Example
///
/// ```ignore
/// let result = inner_wait!(actor, 5000, |inner| async move {
///     inner.get_mut().do_work()
/// }).await?;
/// ```
#[cfg(all(feature = "async_std_time", not(feature = "tokio_time")))]
#[macro_export]
macro_rules! inner_wait {
    ($actor:expr,$timeout:expr,$fun:expr) => {
        async_std::future::timeout(std::time::Duration::from_millis($timeout), $actor.inner_call($fun))
    };
}

/// Run [`RwModel::call_mut`] with a millisecond timeout, returning
/// `Err` if the deadline is exceeded.
///
/// Requires the `tokio_time` feature.
///
/// ```toml
/// aqueue = { version = "^1.4", features = ["tokio_time"] }
/// ```
///
/// # Example
///
/// ```ignore
/// let result = call_mut_wait!(model, 5000, |mut inner| async move {
///     inner.mutate()
/// }).await?;
/// ```
#[cfg(all(feature = "tokio_time", not(feature = "async_std_time")))]
#[macro_export]
macro_rules! call_mut_wait {
    ($model:expr,$timeout:expr,$fun:expr) => {
        tokio::time::timeout(std::time::Duration::from_millis($timeout), $model.call_mut($fun))
    };
}

/// Run [`RwModel::call_mut`] with a millisecond timeout, returning
/// `Err` if the deadline is exceeded.
///
/// Requires the `async_std_time` feature.
///
/// ```toml
/// aqueue = { version = "^1.4", features = ["async_std_time"] }
/// ```
///
/// # Example
///
/// ```ignore
/// let result = call_mut_wait!(model, 5000, |mut inner| async move {
///     inner.mutate()
/// }).await?;
/// ```
#[cfg(all(feature = "async_std_time", not(feature = "tokio_time")))]
#[macro_export]
macro_rules! call_mut_wait {
    ($model:expr,$timeout:expr,$fun:expr) => {
        async_std::future::timeout(std::time::Duration::from_millis($timeout), $model.call_mut($fun))
    };
}

/// Run [`RwModel::call`] with a millisecond timeout, returning
/// `Err` if the deadline is exceeded.
///
/// Requires the `tokio_time` feature.
///
/// ```toml
/// aqueue = { version = "^1.4", features = ["tokio_time"] }
/// ```
///
/// # Example
///
/// ```ignore
/// let result = call_wait!(model, 5000, |inner| async move {
///     inner.read_value()
/// }).await?;
/// ```
#[cfg(all(feature = "tokio_time", not(feature = "async_std_time")))]
#[macro_export]
macro_rules! call_wait {
    ($model:expr,$timeout:expr,$fun:expr) => {
        tokio::time::timeout(std::time::Duration::from_millis($timeout), $model.call($fun))
    };
}

/// Run [`RwModel::call`] with a millisecond timeout, returning
/// `Err` if the deadline is exceeded.
///
/// Requires the `async_std_time` feature.
///
/// ```toml
/// aqueue = { version = "^1.4", features = ["async_std_time"] }
/// ```
///
/// # Example
///
/// ```ignore
/// let result = call_wait!(model, 5000, |inner| async move {
///     inner.read_value()
/// }).await?;
/// ```
#[cfg(all(feature = "async_std_time", not(feature = "tokio_time")))]
#[macro_export]
macro_rules! call_wait {
    ($model:expr,$timeout:expr,$fun:expr) => {
        async_std::future::timeout(std::time::Duration::from_millis($timeout), $model.call($fun))
    };
}