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
|
use super::{poll_abort_signal, wait_abort_signal, AbortSignal, IS_STDOUT_TERMINAL};
use anyhow::{bail, Result};
use crossterm::{
cursor, queue, style,
terminal::{self, disable_raw_mode, enable_raw_mode},
};
use std::{
future::Future,
io::{stdout, Write},
time::Duration,
};
use tokio::{
sync::{mpsc, oneshot},
time::interval,
};
pub struct SpinnerInner {
index: usize,
message: String,
}
impl SpinnerInner {
const DATA: [&'static str; 10] = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"];
fn new(message: &str) -> Self {
SpinnerInner {
index: 0,
message: message.to_string(),
}
}
fn step(&mut self) -> Result<()> {
if !*IS_STDOUT_TERMINAL || self.message.is_empty() {
return Ok(());
}
let mut writer = stdout();
let frame = Self::DATA[self.index % Self::DATA.len()];
let dots = ".".repeat((self.index / 5) % 4);
let line = format!("{frame}{}{:<3}", self.message, dots);
queue!(writer, cursor::MoveToColumn(0), style::Print(line),)?;
if self.index == 0 {
queue!(writer, cursor::Hide)?;
}
writer.flush()?;
self.index += 1;
Ok(())
}
fn set_message(&mut self, message: String) -> Result<()> {
self.clear_message()?;
if !message.is_empty() {
self.message = format!(" {message}");
}
Ok(())
}
fn clear_message(&mut self) -> Result<()> {
if !*IS_STDOUT_TERMINAL || self.message.is_empty() {
return Ok(());
}
self.message.clear();
let mut writer = stdout();
queue!(
writer,
cursor::MoveToColumn(0),
terminal::Clear(terminal::ClearType::FromCursorDown),
cursor::Show
)?;
writer.flush()?;
Ok(())
}
}
#[derive(Clone)]
pub struct Spinner(mpsc::UnboundedSender<SpinnerEvent>);
impl Drop for Spinner {
fn drop(&mut self) {
self.stop();
}
}
impl Spinner {
pub fn set_message(&self, message: String) -> Result<()> {
self.0.send(SpinnerEvent::SetMessage(message))?;
std::thread::sleep(Duration::from_millis(10));
Ok(())
}
pub fn stop(&self) {
let _ = self.0.send(SpinnerEvent::Stop);
std::thread::sleep(Duration::from_millis(10));
}
}
enum SpinnerEvent {
SetMessage(String),
Stop,
}
pub async fn create_spinner(message: &str) -> Spinner {
let message = format!(" {message}");
let (tx, rx) = mpsc::unbounded_channel();
tokio::spawn(run_spinner(message, rx));
Spinner(tx)
}
async fn run_spinner(message: String, mut rx: mpsc::UnboundedReceiver<SpinnerEvent>) -> Result<()> {
let mut spinner = SpinnerInner::new(&message);
let mut interval = interval(Duration::from_millis(50));
loop {
tokio::select! {
_ = interval.tick() => {
let _ = spinner.step();
}
evt = rx.recv() => {
if let Some(evt) = evt {
match evt {
SpinnerEvent::SetMessage(message) => {
spinner.set_message(message)?;
}
SpinnerEvent::Stop => {
spinner.clear_message()?;
break;
}
}
}
}
}
}
Ok(())
}
pub async fn abortable_run_with_spinner<F, T>(
task: F,
message: &str,
abort_signal: AbortSignal,
) -> Result<T>
where
F: Future<Output = Result<T>>,
{
if *IS_STDOUT_TERMINAL {
let (done_tx, done_rx) = oneshot::channel();
let run_task = async {
tokio::select! {
ret = task => {
let _ = done_tx.send(());
ret
}
_ = wait_abort_signal(&abort_signal) => {
let _ = done_tx.send(());
bail!("Aborted.");
},
}
};
let (task_ret, spinner_ret) = tokio::join!(
run_task,
run_abortable_spinner(message, abort_signal.clone(), done_rx)
);
spinner_ret?;
task_ret
} else {
task.await
}
}
async fn run_abortable_spinner(
message: &str,
abort_signal: AbortSignal,
done_rx: oneshot::Receiver<()>,
) -> Result<()> {
enable_raw_mode()?;
let ret = run_abortable_spinner_inner(message, abort_signal, done_rx).await;
disable_raw_mode()?;
ret
}
async fn run_abortable_spinner_inner(
message: &str,
abort_signal: AbortSignal,
mut done_rx: oneshot::Receiver<()>,
) -> Result<()> {
let message = format!(" {message}");
let mut spinner = SpinnerInner::new(&message);
loop {
if abort_signal.aborted() {
break;
}
tokio::time::sleep(Duration::from_millis(25)).await;
match done_rx.try_recv() {
Ok(_) | Err(oneshot::error::TryRecvError::Closed) => {
break;
}
_ => {}
}
if poll_abort_signal(&abort_signal)? {
break;
}
spinner.step()?;
}
spinner.clear_message()?;
Ok(())
}
|