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
use std::thread::JoinHandle;
use std::time::Instant;
use std::{
io::{stdout, Write},
sync::mpsc::{channel, Sender, TryRecvError},
thread,
time::Duration,
};
pub use crate::utils::spinner_names::SpinnerNames as Spinners;
use crate::utils::spinners_data::SPINNERS as SpinnersMap;
mod utils;
pub struct Spinner {
sender: Sender<(Instant, Option<String>)>,
join: Option<JoinHandle<()>>,
}
impl Drop for Spinner {
fn drop(&mut self) {
if self.join.is_some() {
self.sender.send((Instant::now(), None)).unwrap();
self.join.take().unwrap().join().unwrap();
}
}
}
impl Spinner {
/// Create a new spinner along with a message
///
/// # Examples
///
/// Basic Usage:
///
/// ```
/// use spinners::{Spinner, Spinners};
///
/// let sp = Spinner::new(Spinners::Dots, "Loading things into memory...".into());
/// ```
///
/// No Message:
///
/// ```
/// use spinners::{Spinner, Spinners};
///
/// let sp = Spinner::new(Spinners::Dots, String::new());
/// ```
pub fn new(spinner: Spinners, message: String) -> Self {
Self::new_inner(spinner, message, None)
}
/// Create a new spinner that logs the time since it was created
pub fn with_timer(spinner: Spinners, message: String) -> Self {
Self::new_inner(spinner, message, Some(Instant::now()))
}
fn new_inner(spinner: Spinners, message: String, start_time: Option<Instant>) -> Self {
let spinner_name = spinner.to_string();
let spinner_data = SpinnersMap
.get(&spinner_name)
.unwrap_or_else(|| panic!("No Spinner found with the given name: {}", spinner_name));
let (sender, recv) = channel::<(Instant, Option<String>)>();
let join = thread::spawn(move || 'outer: loop {
let mut stdout = stdout();
for frame in spinner_data.frames.iter() {
let (do_stop, stop_time, stop_symbol) = match recv.try_recv() {
Ok((stop_time, stop_symbol)) => (true, Some(stop_time), stop_symbol),
Err(TryRecvError::Disconnected) => (true, None, None),
Err(TryRecvError::Empty) => (false, None, None),
};
let frame = stop_symbol.unwrap_or_else(|| frame.to_string());
match start_time {
None => {
print!("\r{} {}", frame, message);
}
Some(start_time) => {
let now = stop_time.unwrap_or_else(Instant::now);
let duration = now.duration_since(start_time).as_secs_f64();
print!("\r{}{:>10.3} s\t{}", frame, duration, message);
}
}
stdout.flush().unwrap();
if do_stop {
break 'outer;
}
thread::sleep(Duration::from_millis(spinner_data.interval as u64));
}
});
Self {
sender,
join: Some(join),
}
}
/// Stops the spinner
///
/// Stops the spinner that was created with the [`Spinner::new`] function.
///
/// Optionally call [`stop_with_newline`] to print a newline after the spinner is stopped,
/// or the [`stop_with_message`] function to print a message after the spinner is stopped.
///
/// [`Spinner::new`]: struct.Spinner.html#method.new
/// [`stop_with_newline`]: struct.Spinner.html#method.stop_with_newline
/// [`stop_with_message`]: struct.Spinner.html#method.stop_with_message
///
/// # Examples
///
/// Basic Usage:
///
/// ```
/// use spinners::{Spinner, Spinners};
///
/// let mut sp = Spinner::new(Spinners::Dots, "Loading things into memory...".into());
///
/// sp.stop();
/// ```
pub fn stop(&mut self) {
self.stop_inner(Instant::now(), None);
}
/// Stop with a symbol that replaces the spinner
///
/// The symbol is a String rather than a Char to allow for more flexibility, such as using ANSI color codes.
///
/// # Examples
///
/// Basic Usage:
///
/// ```
/// use spinners::{Spinner, Spinners};
///
/// let mut sp = Spinner::new(Spinners::Dots, "Loading things into memory...".into());
///
/// sp.stop_with_symbol("🗸");
/// ```
///
/// ANSI colors (green checkmark):
///
/// ```
/// use spinners::{Spinner, Spinners};
///
/// let mut sp = Spinner::new(Spinners::Dots, "Loading things into memory...".into());
///
/// sp.stop_with_symbol("\x1b[32m🗸\x1b[0m");
/// ```
pub fn stop_with_symbol(&mut self, symbol: &str) {
self.stop_inner(Instant::now(), Some(symbol.to_owned()));
println!();
}
/// Stops the spinner and prints a new line
///
/// # Examples
///
/// Basic Usage:
///
/// ```
/// use spinners::{Spinner, Spinners};
///
/// let mut sp = Spinner::new(Spinners::Dots, "Loading things into memory...".into());
///
/// sp.stop_with_newline();
/// ```
pub fn stop_with_newline(&mut self) {
self.stop();
println!();
}
/// Stops the spinner and prints the provided message
///
/// # Examples
///
/// Basic Usage:
///
/// ```
/// use spinners::{Spinner, Spinners};
///
/// let mut sp = Spinner::new(Spinners::Dots, "Loading things into memory...".into());
///
/// sp.stop_with_message("Finished loading things into memory!".into());
/// ```
pub fn stop_with_message(&mut self, msg: String) {
self.stop();
print!("\r{}", msg);
}
fn stop_inner(&mut self, stop_time: Instant, stop_symbol: Option<String>) {
self.sender
.send((stop_time, stop_symbol))
.expect("Could not stop spinner thread.");
self.join.take().unwrap().join().unwrap();
}
}