able/spinoff
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

fix: optimized ::new()

Browse source
This commit is contained in:
ad4mx 2022-07-15 21:08:36 +02:00
parent 44b79110f6
commit f381c2cc7a
2 changed files with 22 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -1,7 +1,7 @@
# spinoff
`spinoff` is a simple to use library for displaying spinners in the terminal, with plenty of features and options.
[![Cargo version](https://img.shields.io/crates/v/spinoff.svg)](https://crates.io/crates/spinoff) ![Crates.io](https://img.shields.io/crates/l/spinoff.svg) [![Crates.io](https://img.shields.io/crates/d/spinoff.svg)](https://crates.io/crates/spinoff)
[![Version](https://img.shields.io/crates/v/spinoff.svg)](https://crates.io/crates/spinoff) [![Downloads](https://img.shields.io/crates/d/spinoff)](https://crates.io/crates/spinoff) [![License](https://img.shields.io/crates/l/spinoff.svg)](https://crates.io/crates/spinoff)
## Usage

35
src/lib.rs
View file

@ -65,28 +65,25 @@ pub struct Spinner {
/// # Notes
/// * The spinner immediately starts spinning upon creation.
pub fn new(spinner_type: Spinners, msg: StringLiteral, color: Option<StringLiteral>) -> Spinner {
let spinner_data = SPINNER_FRAMES
.get(&spinner_type)
.expect("invalid spinner: expected variant of Spinners enum");
let mut stdout = stdout();
let mut i = 0;
let still_spinning = Arc::new(AtomicBool::new(true));
// Clone the atomic bool so that we can use it in the thread and return the original one later.
let still_spinning_cloned = still_spinning.clone();
// We use atomic bools to make the thread stop itself when the `spinner.stop()` method is called.
thread::spawn(move || {
while still_spinning_cloned.load(std::sync::atomic::Ordering::Relaxed) {
let text = format!(
"\r{} {}",
init_color(color, spinner_data.frames[i].to_string()),
msg
);
let spinner_data = SPINNER_FRAMES.get(&spinner_type).unwrap();
let mut stdout = stdout();
let iterator = spinner_data
.frames
.iter()
.cycle()
.take_while(|_| still_spinning_cloned.load(std::sync::atomic::Ordering::Relaxed));
for frame in iterator {
let text = format!("\r{} {}", init_color(color, frame.to_string()), msg);
stdout.write_all(text.as_bytes()).unwrap();
stdout.flush().unwrap();
thread::sleep(std::time::Duration::from_millis(
spinner_data.interval as u64,
));
i = (i + 1) % spinner_data.frames.len();
}
});
// Return a Spinner struct so we can implement methods on it instead of `spinoff::stop()` etc.
@ -165,7 +162,12 @@ impl Spinner {
/// # Notes
/// * This method will delete the last line of the terminal, so it is recommended to not print anything in between the spinner and the success message.
/// * This method cannot be called if the spinner is already stopped.
pub fn stop_and_persist(self, symbol: StringLiteral, msg: StringLiteral, color: Option<StringLiteral>) {
pub fn stop_and_persist(
self,
symbol: StringLiteral,
msg: StringLiteral,
color: Option<StringLiteral>,
) {
self.clear();
println!("{} {}", init_color(color, symbol.into()), &msg);
}
@ -251,7 +253,12 @@ impl Spinner {
/// * This method will delete the last line of the terminal, so it is recommended to not print anything in between the spinner and the new spinner instance.
/// * This method cannot be called if the spinner is already stopped.
///
pub fn update(self, spinner: Spinners, msg: StringLiteral, color: Option<StringLiteral>) -> Spinner {
pub fn update(
self,
spinner: Spinners,
msg: StringLiteral,
color: Option<StringLiteral>,
) -> Spinner {
self.still_spinning
.store(false, std::sync::atomic::Ordering::Relaxed);
delete_last_line(self.msg);