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 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
/*!
## spinoff
`spinoff` is a simple library for displaying spinners in the terminal.
### Usage
```
# use spinoff::*;
# use std::thread::sleep;
# use std::time::Duration;
#
let mut sp = Spinner::new(spinners::Dots, "Loading...", None);
sleep(Duration::from_millis(800));
sp.success("Success!");
```
### Spinners
This crate provides 80+ spinners out of the box, which you can find in the
[`spinners`] module.
Each spinner provided in this crate is broken up into its own feature. For
example, if you want to use the `dots9` spinner, you need to enable the `dots9`
feature in your `Cargo.toml` (the `dots` feature is enabled by default).
If you want to use a custom spinner, you can use the [`spinner!`] macro.
```
# use spinoff::*;
# use std::thread::sleep;
# use std::time::Duration;
#
let frames = spinner!([">", ">>", ">>>"], 100);
let mut sp = Spinner::new(frames, "Loading...", None);
sleep(Duration::from_millis(800));
sp.success("Success!");
```
### Colors
You can also color your spinners without any hassle. Simply pass a color to the `color` option.
There are 9 colors available: blue, green, red, yellow, cyan, white, magenta, black and a custom variant.
Don't want any of that? Simply pass `None` to the `color` option.
### Note
Currently, the library is designed in a way that doesn't support using multiple spinners at a time. However, that may change in the future.
*/
#![allow(clippy::nursery)]
#![warn(clippy::pedantic)]
use colored::Colorize;
use std::borrow::Cow;
use std::io::Write;
use std::sync::{atomic::AtomicBool, Arc};
use std::thread::sleep;
use std::thread::{self, JoinHandle};
use std::time::Duration;
pub mod spinners;
mod streams;
mod utils;
use spinners::SpinnerFrames;
pub use streams::Streams;
pub use utils::Color;
use utils::{colorize, delete_last_line};
/// Terminal spinner.
pub struct Spinner {
thread_handle: Option<JoinHandle<()>>,
/// This struct has an `Arc<AtomicBool>` field, which is later used in the `stop` type methods to stop the thread printing the spinner.
still_spinning: Arc<AtomicBool>,
spinner_frames: SpinnerFrames,
msg: Cow<'static, str>,
stream: Streams,
color: Option<Color>,
}
/**
Create a new `SpinnerFrames` struct
# Arguments
* `frames` - An array of frames you want to use
* `interval` - The time (in milliseconds) that will pass between frames
# Example
```
# use spinoff::*;
# use std::thread::sleep;
# use std::time::Duration;
#
let frames = spinner!([">", ">>", ">>>"], 100);
let mut sp = Spinner::new(frames, "Hello World!", None);
sleep(Duration::from_millis(800));
sp.stop();
```
*/
#[macro_export]
macro_rules! spinner {
( [ $( $frame:expr ),* ], $interval:expr ) => {
spinners::SpinnerFrames {
interval: $interval,
frames: vec![$($frame),*]
}
};
}
impl Spinner {
/**
Create a new spinner.
# Arguments
* `spinner_type` - The spinner to use.
* `msg` - The message to display.
* `color` - The color of the spinner.
# Example
```
# use spinoff::*;
# use std::thread::sleep;
# use std::time::Duration;
#
let mut sp = Spinner::new(spinners::Dots, "Hello World!", Color::Blue);
sleep(Duration::from_millis(800));
sp.stop();
```
# Notes
* The spinner immediately starts spinning upon creation.
* This function outputs to the `stdout` stream. If you want to use a different stream, use the [`Spinner::new_with_stream`] function.
*/
pub fn new<S, T, U>(spinner_type: S, msg: T, color: U) -> Self
where
S: Into<SpinnerFrames>,
T: Into<Cow<'static, str>>,
U: Into<Option<Color>>,
{
Self::new_with_stream(spinner_type, msg, color, Streams::default())
}
/**
Create a new spinner outputting to a specific stream.
# Arguments
* `spinner_type` - The spinner to use.
* `msg` - The message to display.
* `color` - The color of the spinner.
* `stream` - The stream to output to.
# Example
```
# use spinoff::*;
# use std::thread::sleep;
# use std::time::Duration;
#
let mut sp = Spinner::new_with_stream(spinners::Dots, "I'm outputting to stderr!", Color::Yellow, Streams::Stderr);
sleep(Duration::from_millis(800));
sp.clear();
```
# Notes
* The spinner immediately starts spinning upon creation.
*/
pub fn new_with_stream<S, T, U>(spinner_type: S, msg: T, color: U, stream: Streams) -> Self
where
S: Into<SpinnerFrames>,
T: Into<Cow<'static, str>>,
U: Into<Option<Color>>,
{
let still_spinning = Arc::new(AtomicBool::new(true));
// Gain ownership of the message and color for the thread to use
let spinner_frames = spinner_type.into();
let msg = msg.into();
let color = color.into();
// We use atomic bools to make the thread stop itself when the `spinner.stop()` method is called.
let handle = thread::spawn({
// Clone the atomic bool so that we can use it in the thread and return the original one later.
let still_spinning = Arc::clone(&still_spinning);
let spinner_frames = spinner_frames.clone();
let msg = msg.clone();
move || {
// Iterate over all the frames of the spinner while the atomic bool is true.
let frames = spinner_frames
.frames
.iter()
.cycle()
.take_while(|_| still_spinning.load(std::sync::atomic::Ordering::Relaxed));
// Dynamically delete the last line of the terminal depending on the length of the message + spinner.
let mut last_length = 0;
for frame in frames {
let frame_str = format!("{} {}", colorize(color, frame), msg);
// Get us back to the start of the line.
delete_last_line(last_length, stream);
last_length = frame_str.bytes().len();
write!(stream, "{frame_str}");
stream
.get_stream()
.flush()
.expect("error: failed to flush stream");
thread::sleep(std::time::Duration::from_millis(
u64::from(spinner_frames.interval)
));
}
delete_last_line(last_length, stream);
}
});
// Return a Spinner struct
Self {
thread_handle: Some(handle),
still_spinning,
spinner_frames,
msg,
stream,
color,
}
}
/**
Stop the spinner.
# Example
```
# use spinoff::{spinners, Spinner};
# use std::thread::sleep;
# use std::time::Duration;
#
let mut sp = Spinner::new(spinners::Dots9, "Spinning...", None);
sleep(Duration::from_millis(800));
sp.stop();
#
```
# Notes
* The spinner will be dropped after this method is called, the message will remain though.
*/
pub fn stop(&mut self) {
self.stop_spinner_thread();
// print message
writeln!(self.stream, "{}", self.msg);
}
/**
Stops the spinner and prints a message on a new line.
# Example
```
# use spinoff::{spinners, Spinner};
# use std::thread::sleep;
# use std::time::Duration;
#
let mut sp = Spinner::new(spinners::Dots2, "Hello", None);
sleep(Duration::from_millis(800));
sp.stop_with_message("Bye");
#
```
*/
pub fn stop_with_message(&mut self, msg: &str) {
self.stop_spinner_thread();
// put the message over the spinner
writeln!(self.stream, "{msg}");
}
/**
Deletes the spinner and message and prints a new line with a symbol and message.
# Example
```
# use spinoff::{spinners, Spinner};
# use std::thread::sleep;
# use std::time::Duration;
#
let mut sp = Spinner::new(spinners::Mindblown, "Guess what's coming...", None);
sleep(Duration::from_millis(800));
sp.stop_and_persist("🍕", "Pizza!");
#
```
*/
pub fn stop_and_persist(&mut self, symbol: &str, msg: &str) {
self.stop_spinner_thread();
writeln!(self.stream, "{symbol} {msg}");
}
/**
Deletes the last line of the terminal and prints a success symbol with a message.
# Example
```
# use spinoff::{spinners, Spinner};
# use std::thread::sleep;
# use std::time::Duration;
#
let mut sp = Spinner::new(spinners::Aesthetic, "Trying to load information...", None);
sleep(Duration::from_millis(800));
sp.success("Success!");
#
```
*/
pub fn success(&mut self, msg: &str) {
self.stop_spinner_thread();
writeln!(self.stream, "{} {}", colorize(Some(Color::Green), "✓").bold(), msg);
}
/**
Deletes the last line of the terminal and prints a failure symbol with a message to stderr.
# Example
```
# use spinoff::{spinners, Spinner, Color};
# use std::thread::sleep;
# use std::time::Duration;
#
let mut sp = Spinner::new(spinners::BouncingBar, "Executing code...", Color::Green);
sleep(Duration::from_millis(800));
sp.fail("Code failed to compile!");
#
```
*/
pub fn fail(&mut self, msg: &str) {
self.stop_spinner_thread();
writeln!(self.stream, "{} {}", colorize(Some(Color::Red), "✗").bold(), msg);
}
/**
Deletes the last line of the terminal and prints a warning symbol with a message.
# Example
```
# use spinoff::{spinners, Spinner};
# use std::thread::sleep;
# use std::time::Duration;
#
let mut sp = Spinner::new(spinners::Material, "Measuring network speed...", None);
sleep(Duration::from_millis(800));
sp.warn("You might want to check your internet connection...");
#
```
*/
pub fn warn(&mut self, msg: &str) {
self.stop_spinner_thread();
writeln!(self.stream, "{} {}", colorize(Some(Color::Yellow), "⚠").bold(), msg);
}
/**
Deletes the last line of the terminal and prints an info symbol with a message.
# Example
```
# use spinoff::{spinners, Spinner};
# use std::thread::sleep;
# use std::time::Duration;
#
let mut sp = Spinner::new(spinners::Dots9, "Loading info message...", None);
sleep(Duration::from_millis(800));
sp.info("This is an info message!");
#
```
*/
pub fn info(&mut self, msg: &str) {
self.stop_spinner_thread();
writeln!(self.stream, "{} {}", colorize(Some(Color::Blue), "ℹ").bold(), msg);
}
/**
Updates the spinner.
# Example
```
# use spinoff::*;
# use std::thread::sleep;
# use std::time::Duration;
#
let mut sp = Spinner::new(spinners::Dots, "Hello", None);
sleep(Duration::from_millis(800));
sp.update(spinners::Dots2, "World", None);
sleep(Duration::from_millis(800));
sp.stop();
#
```
*/
pub fn update<S, T, U>(&mut self, spinner: S, msg: T, color: U)
where
S: Into<SpinnerFrames>,
T: Into<Cow<'static, str>>,
U: Into<Option<Color>>,
{
self.stop_spinner_thread();
let _replaced = std::mem::replace(
self,
Self::new_with_stream(spinner, msg, color, self.stream),
);
}
/**
Update the spinner text.
# Example
```
# use spinoff::*;
# use std::thread::sleep;
# use std::time::Duration;
#
let mut sp = Spinner::new(spinners::Arc, "Loading...", Color::Magenta);
sleep(Duration::from_millis(800));
sp.update_text("Not quite finished...");
sleep(Duration::from_millis(800));
sp.update_text("Almost done...");
sleep(Duration::from_millis(800));
sp.success("Done!");
#
```
*/
pub fn update_text<T>(&mut self, msg: T)
where
T: Into<Cow<'static, str>>,
{
self.stop_spinner_thread();
let _replaced = std::mem::replace(
self,
Self::new_with_stream(self.spinner_frames.clone(), msg, self.color, self.stream),
);
}
/**
Updates the spinner text after a certain amount of time has passed since the initial `::new` call.
# Example
```
# use spinoff::*;
# use std::thread::sleep;
# use std::time::Duration;
#
let mut sp = Spinner::new(spinners::Arc, "Loading...", Color::Blue);
sp.update_after_time("Not Done Yet...", Duration::from_secs(2));
sleep(Duration::from_millis(800));
sp.success("Done!");
#
```
# Notes
* This could be used to assure the user that the program is still running.
*/
pub fn update_after_time<T>(&mut self, updated_msg: T, duration: Duration)
where
T: Into<Cow<'static, str>>
{
sleep(duration);
self.stop_spinner_thread();
let _replaced = std::mem::replace(
self,
Self::new_with_stream(self.spinner_frames.clone(), updated_msg, self.color, self.stream),
);
}
/**
Deletes the last line of the terminal.
# Example
```
# use spinoff::{spinners, Spinner};
# use std::thread::sleep;
# use std::time::Duration;
#
let mut sp = Spinner::new(spinners::Grenade, "Clearing...", None);
sleep(Duration::from_millis(800));
sp.clear();
#
```
*/
pub fn clear(&mut self) {
self.stop_spinner_thread();
}
/// Stop the spinner thread and wait for it.
fn stop_spinner_thread(&mut self) {
// Set flag to signal thread to stop
self.still_spinning
.store(false, std::sync::atomic::Ordering::Relaxed);
// Wait for the thread to actually stop
// Also deletes the last line of the terminal after stopped
self.thread_handle
.take()
.expect("Stopping the spinner thread should only happen once.")
.join()
.expect("Thread to join.");
}
}