kdam 0.6.4

A console progress bar library for Rust. (inspired by tqdm & rich.progress)
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

use std::num::NonZeroI16;

/// Generic spinner for rendering spinner animations.
///
/// See more styles at [rich repository](https://github.com/Textualize/rich/blob/master/rich/_spinners.py).
#[derive(Debug, Clone)]
pub struct Spinner {
    frames: Vec<String>,
    interval: f32,
    speed: f32,
}

impl Spinner {
    /// Create a new [Spinner](Self).
    ///
    /// # Example
    ///
    /// ```
    /// use kdam::Spinner;
    ///
    /// let spinner = Spinner::new(
    ///     &[
    ///         "▁▂▃", "▂▃▄", "▃▄▅", "▄▅▆", "▅▆▇",
    ///         "▆▇█", "▇█▇", "█▇▆", "▇▆▅", "▆▅▄",
    ///         "▅▄▃", "▄▃▂", "▃▂▁"
    ///     ],
    ///     30.0,
    ///     1.0
    /// );
    ///
    /// println!("{}", spinner.render_frame(2.89));
    /// ```
    pub fn new(frames: &[&str], interval: f32, speed: f32) -> Self {
        Self {
            frames: frames.iter().map(|x| String::from(*x)).collect(),
            interval,
            speed,
        }
    }

    /// Render a single frame.
    pub fn render_frame(&self, elapsed_time: f32) -> String {
        let frame_no = (elapsed_time * self.speed) / (self.interval / 1000.0);
        self.frames
            .get(frame_no as usize % self.frames.len())
            .unwrap()
            .to_owned()
    }

    /// Render multiple frames upto `ncols` with an pulsating animation.
    pub fn render_frames(&self, elapsed_time: f32, ncols: NonZeroI16) -> String {
        let ncols = ncols.get();
        let pulse = self
            .frames
            .iter()
            .map(|x| x.as_str())
            .collect::<Vec<&str>>()
            .repeat((ncols as f32 / self.frames.len() as f32) as usize + 2);
        let pulse_len = pulse.len();
        let offset = (elapsed_time * 15_f32) as i16 % self.frames.len() as i16;
        let mut pulse_string = String::new();

        for i in offset..(offset + ncols) {
            if 0 > i {
                pulse_string += pulse[pulse_len - (-i as usize)];
            } else {
                pulse_string += pulse[i as usize];
            }
        }

        pulse_string
    }
}