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

use std::time::Duration;
use std::thread::sleep;

/// Spinner provides animation frames which are used by the spinner animation
/// thread to animate a pinned message.
#[derive(Debug, Clone)]
pub struct Spinner {
    /// A sequence of characters which are used for animation. 
    frames: Vec<String>,
    /// Animated speed is provided as FPS.
    speed: u32,
    /// Spinner can format pinned message based on a template string. Use
    /// `#{frame}` and  `#{message}` placeholders to define the output style.
    tpl: String,
}

impl Spinner {
    /// Sets animation frame sequence.
    pub fn set_frames<I, T>(&mut self, frames: I)
        where
        I: IntoIterator<Item = T>,
        T: Into<String>,        
    {
        self.frames = frames.into_iter().map(Into::into).collect();
    }

    /// Sets animation speed. This attribute is used by the `sleep()` method.
    pub fn set_speed(&mut self, speed: u32) {
        self.speed = speed;
    }
    
    /// Returns the next animation frame.
    pub fn next_frame(&mut self) -> String {
        let frame = self.frames.get(0).unwrap_or(&String::new()).to_string();
        self.frames.drain(0..1);
        self.frames.push(frame.clone());
        frame
    }

    /// Returns a formated message of the next animation frame.
    pub fn next_message<M>(&mut self, data: M) -> String
        where
        M: Into<String>,
    {
        self.tpl.clone()
            .replace("#{frame}", &self.next_frame())
            .replace("#{message}", &data.into())
    }

    /// Blocks the thread for the number of ms based on the speed variable.
    pub fn sleep(&mut self) {
        sleep(Duration::from_millis(self.speed.into()));
    }
}

impl Default for Spinner {
    fn default() -> Self {
        Self {
            frames: vec!["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"].iter().map(|i| i.to_string()).collect(),
            speed: 30,
            tpl: String::from("#{frame} #{message}"),
        }
    }
}