appcui 0.4.8

A feature-rich and cross-platform TUI/CUI framework for Rust, enabling modern terminal-based applications on Windows, Linux, and macOS. Includes built-in UI components like buttons, menus, list views, tree views, checkboxes, and more. Perfect for building fast and interactive CLI tools and text-based interfaces.
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236

use super::initialization_flags::Flags;
use crate::prelude::*;
#[cfg(not(target_arch = "wasm32"))]
use std::time::{Duration, Instant};

#[cfg(target_arch = "wasm32")]
use web_time::{Duration, Instant};

#[CustomControl(overwrite=OnPaint, internal=true)]
pub struct ProgressBar {
    items_count: u64,
    items_processed: u64,
    proc_buf: [u8; 4],
    eta: [u8; 8], // hh:mm:ss
    text: String,
    percentage: u8,
    flags: Flags,
    start: Instant,
    extra_duration: Duration,
    paused: bool,
}
impl ProgressBar {
    /// Creates a new ProgressBar control with the maximum number of items to be processed, layout and flags.
    /// The flags can be a combination of the following values:
    /// * `progressbar::Flags::HidePercentage` - if set, the percentage will not be displayed
    ///
    /// # Example
    /// ```rust, no_run
    /// use appcui::prelude::*;
    ///
    /// let mut p = ProgressBar::new(100,layout!("x:1,y:1,w:20"),progressbar::Flags::None);
    /// ```
    pub fn new(items_count: u64, layout: Layout, flags: Flags) -> Self {
        let mut me = Self {
            base: ControlBase::with_status_flags(layout, StatusFlags::Visible | StatusFlags::Enabled),
            items_count,
            items_processed: 0,
            proc_buf: [b' ', b' ', b' ', b' '],
            eta: [b' ', b' ', b' ', b' ', b' ', b' ', b' ', b' '],
            text: String::new(),
            percentage: 0,
            flags,
            start: Instant::now(),
            extra_duration: Duration::default(),
            paused: false,
        };
        me.update_progress(0);
        me.set_size_bounds(4, 1, u16::MAX, 2);
        me
    }

    /// Updates the text displayed on the progress bar
    ///
    /// # Example
    /// ```rust,no_run
    /// use appcui::prelude::*;
    ///
    /// let mut p = ProgressBar::new(100,layout!("x:1,y:1,w:20"),progressbar::Flags::None);
    /// p.update_text("Running ...");
    /// ```
    pub fn update_text(&mut self, text: &str) {
        self.text.clear();
        self.text.push_str(text);
    }

    /// Updates the progress bar with the number of items processed so far. The progress bar will
    /// automatically calculate the percentage and ETA and will update the display.
    /// If the progress bar is paused, calling this method will resume the progress bar.
    ///
    /// # Example
    /// ```rust,no_run
    /// use appcui::prelude::*;
    ///
    /// let mut p = ProgressBar::new(100,layout!("x:1,y:1,w:20"),progressbar::Flags::None);
    /// p.update_progress(85);
    /// ```
    pub fn update_progress(&mut self, processed_items: u64) {
        if self.paused {
            self.resume();
        }
        self.items_processed = processed_items.min(self.items_count);
        if self.items_count == 0 {
            self.proc_buf = [b'-', b'-', b'-', b'%'];
            self.eta = [b'-', b'-', b':', b'-', b'-', b':', b'-', b'-'];
            self.percentage = 0;
        } else if self.items_processed >= self.items_count {
            self.proc_buf = [b'1', b'0', b'0', b'%'];
            self.eta = [b'0', b'0', b':', b'0', b'0', b':', b'0', b'0'];
            self.percentage = 100;
        } else {
            if self.items_processed > 0xFFFF_FFFF_FFFF_FF00 {
                self.percentage = ((self.items_processed as u128 * 100u128) / self.items_count as u128) as u8;
            } else {
                self.percentage = ((self.items_processed * 100) / self.items_count) as u8;
            }
            self.proc_buf[3] = b'%';
            self.proc_buf[2] = (self.percentage % 10) + 48;
            let proc = self.percentage / 10;
            if proc > 0 {
                self.proc_buf[1] = (proc % 10) + 48;
                let proc = proc / 10;
                if proc > 0 {
                    self.proc_buf[0] = proc + 48;
                } else {
                    self.proc_buf[0] = 32;
                }
            } else {
                self.proc_buf[1] = 32;
                self.proc_buf[0] = 32;
            }
            self.update_eta();
        }
    }

    #[inline(always)]
    pub(super) fn update_eta_with_elapsed_time(&mut self, elapsed: u64) {
        let total_time = (elapsed as u128 * self.items_count as u128 / self.items_processed as u128) as u64;
        let eta = total_time - elapsed;
        if eta >= 604800 {
            self.eta = [b' ', b'>', b'1', b' ', b'w', b'e', b'e', b'k'];
        } else {
            let days = eta / 86400;
            if days > 0 {
                if days == 1 {
                    self.eta = [b' ', b' ', b'>', b'1', b' ', b'd', b'a', b'y'];
                } else {
                    self.eta = [b' ', b'>', 48 + days as u8, b' ', b'd', b'a', b'y', b's'];
                }
            } else {
                let hours = eta / 3600;
                let minutes = (eta % 3600) / 60;
                let seconds = eta % 60;
                self.eta[0] = (hours / 10) as u8 + 48;
                self.eta[1] = (hours % 10) as u8 + 48;
                self.eta[2] = b':';
                self.eta[3] = (minutes / 10) as u8 + 48;
                self.eta[4] = (minutes % 10) as u8 + 48;
                self.eta[5] = b':';
                self.eta[6] = (seconds / 10) as u8 + 48;
                self.eta[7] = (seconds % 10) as u8 + 48;
            }
        }
    }
    fn update_eta(&mut self) {
        if self.items_processed == 0 {
            self.eta = [b'-', b'-', b':', b'-', b'-', b':', b'-', b'-'];
            return;
        }
        let elapsed = (self.start.elapsed() + self.extra_duration).as_secs();
        self.update_eta_with_elapsed_time(elapsed);
    }

    /// Returns the number of items processed so far
    #[inline(always)]
    pub fn processed(&self) -> u64 {
        self.items_processed
    }

    /// Returns the total items that need to be processed
    #[inline(always)]
    pub fn count(&self) -> u64 {
        self.items_count
    }

    /// Resumes the progress bar. This will restart the timer and will continue the progress bar
    /// from the last position. Calling this method multiple times have no effect if the progress
    /// bar is already running.
    #[inline(always)]
    pub fn resume(&mut self) {
        if self.paused {
            self.start = Instant::now();
            self.paused = false;
        }
    }

    /// Pauses the progress bar. This will stop the timer and will pause the progress bar.
    /// Calling this method multiple times have no effect if the progress bar is already paused.
    #[inline(always)]
    pub fn pause(&mut self) {
        if !self.paused {
            self.extra_duration += self.start.elapsed();
            self.paused = true;
        }
    }

    /// Returns true if the ProgressBar is paused or false otherwise
    #[inline(always)]
    pub fn is_paused(&self) -> bool {
        self.paused
    }

    /// Resets the progress bar internal state (items processed, timer, etc). This is usefull if you
    /// want to restart the progress bar from the beginning or if you want to reuse the same progress
    /// bar for multiple operations.
    #[inline(always)]
    pub fn reset(&mut self, items_count: u64) {
        self.items_count = items_count;
        self.extra_duration = Duration::default();
        self.start = Instant::now();
        self.paused = false;
        self.update_progress(0);
    }
}
impl OnPaint for ProgressBar {
    fn on_paint(&self, surface: &mut Surface, theme: &Theme) {
        let w = self.size().width as i32;
        let m = w * (self.percentage as i32) / 100;
        surface.fill_horizontal_line(
            0,
            0,
            m,
            Character::new(' ', theme.progressbar.text, theme.progressbar.progress, CharFlags::None),
        );
        surface.fill_horizontal_line(
            m,
            0,
            w,
            Character::new(' ', theme.progressbar.text, theme.progressbar.background, CharFlags::None),
        );
        let attr = CharAttribute::with_fore_color(theme.progressbar.text);
        surface.write_string(1, 0, &self.text, attr, false);
        if !self.flags.contains(Flags::HidePercentage) {
            surface.write_ascii(w - 5, 0, &self.proc_buf, attr, false);
        }
        if self.size().height > 1 {
            if self.paused {
                surface.write_ascii(w - 6, 1, "Paused".as_bytes(), theme.text.error, false);
            } else {
                surface.write_ascii(w - 8, 1, &self.eta, theme.text.focused, false);
            }
            if w > 12 {
                surface.write_string(0, 1, "ETA:", theme.text.normal, false);
            }
        }
    }
}