strides 0.4.0

Async-first terminal UI spinners and progress bars
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

//! Shared progress theme configuration.
//!
//! A [`Theme`] bundles a [`Spinner`] and a [`Bar`] together with an optional bar width
//! and is the value accepted by [`FutureExt`](crate::future::FutureExt),
//! [`StreamExt`](crate::stream::StreamExt) and [`Group`](crate::future::Group). A bare
//! [`Spinner`] also converts into a `Theme` via [`From`], so callers that only need a
//! spinner can pass one directly.
//!
//! ```rust
//! use strides::{bar, spinner, Theme};
//!
//! let theme = Theme::new()
//!     .with_spinner(spinner::styles::DOTS_3)
//!     .with_bar(bar::styles::SHADED)
//!     .with_bar_width(40);
//! ```

use crate::bar::Bar;
use crate::spinner::Spinner;

/// Combined theme for progress display, bundling a [`Spinner`] and a [`Bar`].
#[derive(Clone)]
pub struct Theme<'a> {
    /// Spinner style to indicate activity.
    pub(crate) spinner: Spinner<'a>,
    /// Bar style to indicate progress.
    pub(crate) bar: Bar<'a>,
    /// Width of the progress bar in characters.
    pub(crate) bar_width: Option<usize>,
}

impl<'a> Default for Theme<'a> {
    fn default() -> Self {
        Self::new()
    }
}

impl<'a> Theme<'a> {
    /// Create a new theme with an inactive spinner, no bar, and an
    /// auto-detected bar width.
    pub const fn new() -> Self {
        Self {
            spinner: Spinner::inactive(),
            bar: Bar::empty(),
            bar_width: None,
        }
    }

    /// Set the [`Spinner`] used to indicate ongoing activity.
    pub const fn with_spinner(mut self, spinner: Spinner<'a>) -> Self {
        self.spinner = spinner;
        self
    }

    /// Set the [`Bar`] used to render fractional progress.
    pub const fn with_bar(mut self, bar: Bar<'a>) -> Self {
        self.bar = bar;
        self
    }

    /// Override the bar width in characters. When unset the width is derived from the terminal
    /// size (clamped to `10..=80`), falling back to `40` if the size cannot be detected.
    pub const fn with_bar_width(mut self, width: usize) -> Self {
        self.bar_width = Some(width);
        self
    }

    pub(crate) fn effective_bar_width(&self) -> usize {
        self.bar_width.unwrap_or_else(|| {
            terminal_size::terminal_size()
                .map(|(w, _)| (w.0 as usize).saturating_sub(20).clamp(10, 80))
                .unwrap_or(40)
        })
    }
}

impl<'a> From<Spinner<'a>> for Theme<'a> {
    fn from(spinner: Spinner<'a>) -> Self {
        Theme::default().with_spinner(spinner)
    }
}