termal_core 5.0.0

This library contains implementation for the termal library
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

use std::{
    fmt::{Display, Write as _},
    io::{Write as _, stdout},
    time::Duration,
};

use crate::{
    codes,
    progress::{ProgressFormatter, duration_to_string},
};

/// A progress tracker that uses triple dots.
pub struct Dots {
    pub log: bool,
    buf: String,
}

/// A simple tracker that tracks only completion.
pub fn dots<T>(task: &str, f: impl FnOnce() -> T) -> T {
    let mut d = Dots::default();
    d.start(task, "");
    let res = f();
    d.finish(task, "", Duration::default());
    res
}

/// A simple tracker that tracks only completion and failure.
pub fn dots_try<T, E: Display>(
    task: &str,
    f: impl FnOnce() -> Result<T, E>,
) -> Result<T, E> {
    let mut d = Dots::default();
    d.start(task, "");
    match f() {
        res @ Ok(_) => {
            d.finish(task, "", Duration::default());
            res
        }
        Err(e) => {
            d.fail(None, task, "", Duration::default(), &format!("{e}"));
            Err(e)
        }
    }
}

impl Dots {
    fn show_progress(
        &mut self,
        done: Option<f32>,
        task: &str,
        info: &str,
        eta: Option<Duration>,
    ) {
        self.buf.clear();
        self.buf += codes::ERASE_TO_END;
        self.buf += codes::CUR_SAVE;
        self.format_progress(done, task, info, eta);
        self.buf += codes::CUR_LOAD;
        print!("{}", self.buf);
        _ = stdout().flush();
        if self.log {
            print!("{}", codes::ERASE_TO_END);
        }
    }

    fn format_progress(
        &mut self,
        done: Option<f32>,
        task: &str,
        info: &str,
        eta: Option<Duration>,
    ) {
        self.buf += task;
        self.buf += "...";

        if let Some(done) = done {
            _ = write!(self.buf, " \x1b[96m{:.2} %\x1b[0m", done * 100.);
        }

        if let Some(time) = eta {
            self.buf += " [\x1b[95m";
            duration_to_string(time, true, &mut self.buf);
            self.buf += "\x1b[0m]"
        }

        if !info.is_empty() {
            self.buf.push(' ');
            self.buf += info;
        }
    }
}

impl ProgressFormatter for Dots {
    fn start(&mut self, task: &str, info: &str) {
        self.show_progress(None, task, info, None);
    }

    fn update(
        &mut self,
        done: Option<f32>,
        task: &str,
        info: &str,
        time: Duration,
    ) {
        self.show_progress(done, task, info, Some(time));
    }

    fn finish(&mut self, task: &str, _: &str, _: Duration) {
        self.buf.clear();
        self.buf += codes::ERASE_TO_END;
        self.format_progress(None, task, "\x1b[92mDone!\x1b[0m", None);
        println!("{}", self.buf);
    }

    fn fail(
        &mut self,
        _: Option<f32>,
        task: &str,
        _: &str,
        _: Duration,
        err: &str,
    ) {
        self.buf.clear();
        self.buf += codes::ERASE_TO_END;
        self.format_progress(None, task, "\x1b[91mFailed!\x1b[0m", None);
        println!("{}\n\x1b[91merror:\x1b[0m {err}", self.buf);
    }
}

impl Default for Dots {
    fn default() -> Self {
        Self {
            log: true,
            buf: String::new(),
        }
    }
}