loaders 0.0.0

A fully-featured, customisable progress bar and loading indicator library for Rust CLI and terminal applications
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
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

//! Built-in progress bar themes.

use crate::style::color::{Color, ColorSpec};
use crate::style::style::ProgressStyle;

/// Built-in progress bar themes.
///
/// Themes are lightweight factories for `ProgressStyle` values.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Theme {
    /// ASCII default theme.
    Default,
    /// Heavy Unicode line theme.
    Unicode,
    /// Braille-inspired theme.
    Braille,
    /// Block character theme.
    Block,
    /// Minimal unboxed theme.
    Minimal,
    /// Color-enhanced default theme.
    Colorful,
    /// Shaded gradient theme.
    Gradient,
    /// Retro terminal theme.
    Retro,
    /// Dot-based theme.
    Dots,
    /// Rounded dot and line theme.
    Rounded,
    /// Small shaded-square theme.
    Shaded,
    /// Arrow-heavy theme.
    Arrows,
}

impl Theme {
    /// Returns a configured style for this theme.
    ///
    /// # Examples
    ///
    /// ```rust
    /// let style = loaders::Theme::Unicode.style();
    /// assert!(format!("{style:?}").contains("━"));
    /// ```
    pub fn style(&self) -> ProgressStyle {
        match self {
            Self::Default => themed("[{bar:30}] {pos}/{len} {msg}", "#>-"),
            Self::Unicode => themed("[{bar:30}] {pos}/{len} {msg}", "━╸░"),
            Self::Braille => themed("[{bar:30}] {pos}/{len} {msg}", "⣿⣷⣦"),
            Self::Block => themed("[{bar:30}] {pos}/{len} {msg}", "█▉▒"),
            Self::Minimal => themed("{bar:30} {pos}/{len} {msg}", "=>."),
            Self::Colorful => themed("[{bar:30.green/red}] {percent}% {msg}", "#>-")
                .color(ColorSpec::new().set_fg(Color::BrightGreen).set_bold(true)),
            Self::Gradient => themed("[{bar:30}] {percent}% {msg}", "█▓▒░"),
            Self::Retro => themed("[{bar:30}] {pos}/{len} {msg}", "=>-"),
            Self::Dots => themed("[{bar:30}] {percent}% {msg}", "•∘ "),
            Self::Rounded => themed("[{bar:30}] {percent}% {msg}", "●○─"),
            Self::Shaded => themed("[{bar:30}] {percent}% {msg}", "▪▫ "),
            Self::Arrows => themed("[{bar:30}] {percent}% {msg}", ">->"),
        }
    }

    /// Returns the human-readable theme name.
    ///
    /// # Examples
    ///
    /// ```rust
    /// assert_eq!(loaders::Theme::Default.name(), "default");
    /// ```
    pub fn name(&self) -> &'static str {
        match self {
            Self::Default => "default",
            Self::Unicode => "unicode",
            Self::Braille => "braille",
            Self::Block => "block",
            Self::Minimal => "minimal",
            Self::Colorful => "colorful",
            Self::Gradient => "gradient",
            Self::Retro => "retro",
            Self::Dots => "dots",
            Self::Rounded => "rounded",
            Self::Shaded => "shaded",
            Self::Arrows => "arrows",
        }
    }

    /// Returns all built-in themes.
    ///
    /// # Examples
    ///
    /// ```rust
    /// assert!(loaders::Theme::all().len() >= 12);
    /// ```
    pub fn all() -> &'static [Theme] {
        static THEMES: [Theme; 12] = [
            Theme::Default,
            Theme::Unicode,
            Theme::Braille,
            Theme::Block,
            Theme::Minimal,
            Theme::Colorful,
            Theme::Gradient,
            Theme::Retro,
            Theme::Dots,
            Theme::Rounded,
            Theme::Shaded,
            Theme::Arrows,
        ];
        &THEMES
    }
}

fn themed(template: &str, chars: &str) -> ProgressStyle {
    match ProgressStyle::with_template(template) {
        Ok(style) => style.progress_chars(chars),
        Err(_) => ProgressStyle::default_bar().progress_chars(chars),
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::collections::HashSet;

    #[test]
    fn test_all_themes_return_valid_style() {
        for theme in Theme::all() {
            assert!(!theme.style().parsed_template.parts.is_empty());
        }
    }

    #[test]
    fn test_theme_names_unique() {
        let names: HashSet<&str> = Theme::all().iter().map(Theme::name).collect();
        assert_eq!(names.len(), Theme::all().len());
    }

    #[test]
    fn test_theme_all_count() {
        assert_eq!(Theme::all().len(), 12);
    }

    #[test]
    fn test_default_theme_style() {
        assert_eq!(Theme::Default.style().progress_chars, "#>-");
    }

    #[test]
    fn test_colorful_theme_has_color() {
        assert!(Theme::Colorful.style().color_spec.is_some());
    }
}