spinners 4.2.0

🛎 60+ Elegant terminal spinners for Rust
Documentation 
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

use std::{io::{Write, stdout, stderr, Result}, time::Instant};
#[cfg(feature = "osc-progress")]
use std::io::IsTerminal;

/// OSC 9;4 escape sequence for indeterminate/pulsing progress (state 3)
#[cfg(feature = "osc-progress")]
const OSC9_4_INDETERMINATE: &str = "\x1b]9;4;3\x1b\\";

/// OSC 9;4 escape sequence to remove/hide progress (state 0)
#[cfg(feature = "osc-progress")]
const OSC9_4_REMOVE: &str = "\x1b]9;4;0\x1b\\";

/// Handles the Printing logic for the Spinner
#[derive(Default, Copy, Clone)]
pub enum Stream {
    #[default]
    Stderr,
    Stdout,
}
impl Stream {
    /// Matches on self and returns the internal writer
    fn match_target(&self) -> Box<dyn Write> {
        match self {
            Self::Stderr => Box::new(stderr()),
            Self::Stdout => Box::new(stdout())
        }
    }

    /// Writes the message without duration
    fn print_message(
            writer: &mut Box<dyn Write>, 
            frame: &str, 
            message: &str) -> Result<()>
    {
        write!(writer, "\r{} {}", frame, message)?;
        writer.flush()
    }

    /// Writes the message with the duration
    fn print_message_with_duration(
            writer: &mut Box<dyn Write>, 
            frame: &str, 
            message: &str, 
            start_time: Instant,
            stop_time: Option<Instant>) -> Result<()> 
    {
        let now = stop_time.unwrap_or_else(Instant::now);
        let duration = now.duration_since(start_time).as_secs_f64();
        write!(writer, "\r{}{:>10.3} s\t{}", frame, duration, message)?;
        writer.flush()
    }

    /// Writes the current message and optionally prints the durations
    pub fn write(
            &self,
            frame: &str, 
            message: &str, 
            start_time: Option<Instant>,
            stop_time: Option<Instant>) -> Result<()>
    {
        let mut writer = self.match_target();
        match start_time {
            None => Self::print_message(
                &mut writer, frame, message)?,
            Some(start_time) => Self::print_message_with_duration(
                &mut writer, frame, message, start_time, stop_time)?
        };
        Ok(())
    }

    /// Handles the stopping logic given an optional message and symbol
    pub fn stop(
            &self,
            message: Option<&str>,
            symbol: Option<&str>) -> Result<()> 
    {
        let mut writer = self.match_target();
        match (message, symbol) {
            // persist with symbol and message
            (Some(m), Some(s)) => writeln!(writer, "\x1b[2K\r{} {}", s, m),

            // persist with message only
            (Some(m), None) => writeln!(writer, "\x1b[2K\r{}", m),

            // simple newline
            _ => writeln!(writer)
        }?;
        writer.flush()
    }

    /// Returns whether the underlying stream is a terminal
    #[cfg(feature = "osc-progress")]
    pub fn is_terminal(&self) -> bool {
        match self {
            Self::Stderr => stderr().is_terminal(),
            Self::Stdout => stdout().is_terminal(),
        }
    }

    /// Emits OSC 9;4 indeterminate progress (state 3)
    #[cfg(feature = "osc-progress")]
    pub fn osc_start(&self) {
        if self.is_terminal() {
            let mut w = self.match_target();
            let _ = write!(w, "{}", OSC9_4_INDETERMINATE);
        }
    }

    /// Emits OSC 9;4 remove progress (state 0)
    #[cfg(feature = "osc-progress")]
    pub fn osc_stop(&self) {
        if self.is_terminal() {
            let mut w = self.match_target();
            let _ = write!(w, "{}", OSC9_4_REMOVE);
        }
    }

    /// Flushes the underlying stream
    #[cfg(feature = "osc-progress")]
    pub fn osc_flush(&self) {
        let mut w = self.match_target();
        let _ = w.flush();
    }

}