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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
#![cfg_attr(not(debug_assertions), deny(unused_variables))]
#![cfg_attr(not(debug_assertions), deny(unused_imports))]
#![cfg_attr(not(debug_assertions), deny(dead_code))]
#![cfg_attr(not(debug_assertions), deny(unused_extern_crates))]
#![deny(unused_must_use)]
#![deny(unreachable_patterns)]
#![deny(unknown_lints)]
use futures::{
channel::{oneshot, oneshot::Canceled},
future::{Fuse, FusedFuture, Shared},
task::{Context, Poll},
Future,
FutureExt,
};
use std::pin::Pin;
pub struct Shutdown {
trigger: Option<oneshot::Sender<()>>,
signal: ShutdownSignal,
on_triggered: Option<Box<dyn FnOnce() + Send + Sync>>,
}
impl Shutdown {
pub fn new() -> Self {
let (tx, rx) = oneshot::channel();
Self {
trigger: Some(tx),
signal: rx.fuse().shared(),
on_triggered: None,
}
}
pub fn on_triggered<F>(&mut self, on_trigger: F) -> &mut Self
where F: FnOnce() + Send + Sync + 'static {
self.on_triggered = Some(Box::new(on_trigger));
self
}
pub fn to_signal(&self) -> ShutdownSignal {
self.signal.clone()
}
pub fn trigger(&mut self) -> Result<(), ()> {
match self.trigger.take() {
Some(trigger) => {
trigger.send(())?;
if let Some(on_triggered) = self.on_triggered.take() {
on_triggered();
}
Ok(())
},
None => Ok(()),
}
}
pub fn is_triggered(&self) -> bool {
self.trigger.is_none()
}
}
impl Drop for Shutdown {
fn drop(&mut self) {
let _ = self.trigger();
}
}
impl Default for Shutdown {
fn default() -> Self {
Self::new()
}
}
pub type ShutdownSignal = Shared<Fuse<oneshot::Receiver<()>>>;
#[derive(Debug, Clone, Default)]
pub struct OptionalShutdownSignal(Option<ShutdownSignal>);
impl OptionalShutdownSignal {
pub fn none() -> Self {
Self(None)
}
pub fn set(&mut self, signal: ShutdownSignal) -> &mut Self {
self.0 = Some(signal);
self
}
pub fn is_none(&self) -> bool {
self.0.is_none()
}
pub fn into_signal(self) -> Option<ShutdownSignal> {
self.0
}
pub fn take(&mut self) -> Option<ShutdownSignal> {
self.0.take()
}
}
impl Future for OptionalShutdownSignal {
type Output = Result<(), Canceled>;
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
match self.0.as_mut() {
Some(inner) => inner.poll_unpin(cx),
None => Poll::Pending,
}
}
}
impl From<Option<ShutdownSignal>> for OptionalShutdownSignal {
fn from(inner: Option<ShutdownSignal>) -> Self {
Self(inner)
}
}
impl From<ShutdownSignal> for OptionalShutdownSignal {
fn from(inner: ShutdownSignal) -> Self {
Self(Some(inner))
}
}
impl FusedFuture for OptionalShutdownSignal {
fn is_terminated(&self) -> bool {
self.0.as_ref().map(FusedFuture::is_terminated).unwrap_or(false)
}
}
#[cfg(test)]
mod test {
use super::*;
use std::sync::{
atomic::{AtomicBool, Ordering},
Arc,
};
use tokio::runtime::Runtime;
#[test]
fn trigger() {
let rt = Runtime::new().unwrap();
let mut shutdown = Shutdown::new();
let signal = shutdown.to_signal();
assert_eq!(shutdown.is_triggered(), false);
rt.spawn(async move {
signal.await.unwrap();
});
shutdown.trigger().unwrap();
shutdown.trigger().unwrap();
assert_eq!(shutdown.is_triggered(), true);
}
#[test]
fn signal_clone() {
let rt = Runtime::new().unwrap();
let mut shutdown = Shutdown::new();
let signal = shutdown.to_signal();
let signal_clone = signal.clone();
rt.spawn(async move {
signal_clone.await.unwrap();
signal.await.unwrap();
});
shutdown.trigger().unwrap();
}
#[test]
fn drop_trigger() {
let rt = Runtime::new().unwrap();
let shutdown = Shutdown::new();
let signal = shutdown.to_signal();
let signal_clone = signal.clone();
rt.spawn(async move {
signal_clone.await.unwrap();
signal.await.unwrap();
});
drop(shutdown);
}
#[test]
fn on_trigger() {
let rt = Runtime::new().unwrap();
let spy = Arc::new(AtomicBool::new(false));
let spy_clone = Arc::clone(&spy);
let mut shutdown = Shutdown::new();
shutdown.on_triggered(move || {
spy_clone.store(true, Ordering::SeqCst);
});
let signal = shutdown.to_signal();
rt.spawn(async move {
signal.await.unwrap();
});
shutdown.trigger().unwrap();
assert_eq!(spy.load(Ordering::SeqCst), true);
}
}