anstyle-progress 0.1.0

ANSI escape code progress reporting (OSC 9;4)
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

/// Terminal progress formatter
///
/// # Example
///
/// ```rust
/// # use anstyle_progress::TermProgress;
/// # use anstyle_progress::TermProgressStatus;
/// let mut progress = TermProgress::start();
///
/// let progress = progress.percent(0);
/// println!("{progress}");
///
/// let progress = progress.percent(50);
/// println!("{progress}");
///
/// let progress = progress.percent(100);
/// println!("{progress}");
///
/// let progress = TermProgress::remove();
/// println!("{progress}");
/// ```
#[derive(Copy, Clone)]
pub struct TermProgress {
    status: Option<TermProgressStatus>,
    percent: Option<u8>,
}

impl TermProgress {
    /// No progress to display
    pub fn none() -> Self {
        Self {
            status: None,
            percent: None,
        }
    }

    /// Start a progress indicator
    ///
    /// This starts in an indeterminate state
    pub fn start() -> Self {
        Self::none().status(TermProgressStatus::Normal)
    }

    /// Start an error indicator
    pub fn error() -> Self {
        Self::none().status(TermProgressStatus::Error)
    }

    /// Remove the indicator
    pub fn remove() -> Self {
        Self::none().status(TermProgressStatus::Removed)
    }

    /// Set progress percentage (between `0..=100`)
    ///
    /// Without setting this, progress will be indeterminate
    pub fn percent(mut self, percent: u8) -> Self {
        assert!(matches!(percent, 0..=100));
        self.percent = Some(percent);
        self
    }

    /// Change the reported status
    pub fn status(mut self, status: TermProgressStatus) -> Self {
        self.status = Some(status);
        self
    }
}

impl Default for TermProgress {
    fn default() -> Self {
        Self::none()
    }
}

/// Reported status along with progress
#[allow(missing_docs)]
#[derive(Copy, Clone)]
pub enum TermProgressStatus {
    Removed,
    Normal,
    /// Some terminals treat this as a Warning
    Paused,
    Error,
}

impl core::fmt::Display for TermProgress {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        let Some(status) = self.status else {
            return Ok(());
        };
        let (st, pr) = match (status, self.percent) {
            (TermProgressStatus::Removed, _) => (0, None),
            (TermProgressStatus::Normal, Some(_)) => (1, self.percent),
            (TermProgressStatus::Error, _) => (2, self.percent),
            (TermProgressStatus::Normal, None) => (3, None),
            (TermProgressStatus::Paused, _) => (4, self.percent),
        };
        write!(f, "\x1b]9;4;{st};")?;
        if let Some(pr) = pr {
            write!(f, "{pr}")?;
        }
        write!(f, "\x1b\\")
    }
}