anstyle-progress 0.0.1

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

/// Terminal progress formatter
///
/// # Example
///
/// ```rust
/// # use anstyle_progress::TermProgress;
/// # use anstyle_progress::TermProgressStatus;
/// let mut progress = anstyle_progress::TermProgress::none()
///   .status(TermProgressStatus::Normal);
///
/// let progress = progress.percent(Some(0));
/// println!("{progress}");
///
/// let progress = progress.percent(Some(50));
/// println!("{progress}");
///
/// let progress = progress.percent(Some(100));
/// println!("{progress}");
///
/// 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,
        }
    }

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

    /// Between `0..=100`
    pub fn percent(mut self, percent: Option<u8>) -> Self {
        assert!(matches!(percent, Some(0..=100) | None));
        self.percent = percent;
        self
    }
}

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

/// Reported status along with progress
#[allow(missing_docs)]
#[derive(Copy, Clone)]
pub enum TermProgressStatus {
    Normal,
    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 = match (f.alternate(), status, self.percent) {
            (true, _, _) => 0,
            (false, TermProgressStatus::Normal, Some(_)) => 1,
            (false, TermProgressStatus::Error, _) => 2,
            (false, TermProgressStatus::Normal, None) => 3,
            (false, TermProgressStatus::Paused, _) => 4,
        };
        let pr = self.percent.unwrap_or(0);
        write!(f, "\x1b]9;4;{st};{pr}\x1b\\")
    }
}