crustkit 0.2.0

Small Ratatui and Crossterm primitives for terminal applications.
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

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

use ratatui::{
    style::Style,
    text::Span,
    widgets::{Block, Gauge},
};

#[derive(Debug, Clone, Copy, PartialEq)]
pub struct TransferProgress {
    pub downloaded_bytes: u64,
    pub total_bytes: Option<u64>,
    pub elapsed: Duration,
}

impl TransferProgress {
    pub const fn new(downloaded_bytes: u64, total_bytes: Option<u64>, elapsed: Duration) -> Self {
        Self {
            downloaded_bytes,
            total_bytes,
            elapsed,
        }
    }

    pub fn ratio(self) -> Option<f64> {
        let total = self.total_bytes?;
        if total == 0 {
            return Some(1.0);
        }
        Some((self.downloaded_bytes as f64 / total as f64).clamp(0.0, 1.0))
    }

    pub fn bytes_per_second(self) -> Option<f64> {
        let elapsed = self.elapsed.as_secs_f64();
        if elapsed <= f64::EPSILON {
            return None;
        }
        Some(self.downloaded_bytes as f64 / elapsed)
    }

    pub fn summary(self) -> String {
        let ratio = self.ratio();
        let speed = self.bytes_per_second();
        let mut summary = String::with_capacity(48);

        match ratio {
            Some(ratio) => {
                let _ = write!(summary, "{:>5.1}%  ", ratio * 100.0);
            }
            None => summary.push_str("  ---%  "),
        }

        write_bytes(&mut summary, self.downloaded_bytes);
        if let Some(total) = self.total_bytes {
            summary.push_str(" / ");
            write_bytes(&mut summary, total);
        }
        summary.push_str("  ");
        if let Some(speed) = speed {
            write_bytes(&mut summary, speed.max(0.0) as u64);
            summary.push_str("/s");
        } else {
            summary.push_str("-/s");
        }

        summary
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ProgressBarTheme {
    pub base_style: Style,
    pub bar_style: Style,
    pub label_style: Style,
}

impl ProgressBarTheme {
    pub const fn new(base_style: Style, bar_style: Style, label_style: Style) -> Self {
        Self {
            base_style,
            bar_style,
            label_style,
        }
    }
}

pub fn transfer_progress_gauge<'a>(
    progress: TransferProgress,
    theme: ProgressBarTheme,
) -> Gauge<'a> {
    let gauge = Gauge::default()
        .block(Block::default())
        .style(theme.base_style)
        .gauge_style(theme.bar_style)
        .label(Span::styled(progress.summary(), theme.label_style));

    match progress.ratio() {
        Some(ratio) => gauge.ratio(ratio),
        None => gauge.ratio(0.0),
    }
}

pub fn format_bytes(bytes: u64) -> String {
    let mut output = String::with_capacity(10);
    write_bytes(&mut output, bytes);
    output
}

fn write_bytes(output: &mut String, bytes: u64) {
    const UNITS: [&str; 5] = ["B", "KB", "MB", "GB", "TB"];
    let mut value = bytes as f64;
    let mut unit = UNITS[0];
    for candidate in UNITS.iter().skip(1) {
        if value < 1024.0 {
            break;
        }
        value /= 1024.0;
        unit = candidate;
    }

    if unit == "B" {
        let _ = write!(output, "{bytes} B");
    } else {
        let _ = write!(output, "{value:.1} {unit}");
    }
}

pub fn format_bytes_per_second(bytes_per_second: f64) -> String {
    format!("{}/s", format_bytes(bytes_per_second.max(0.0) as u64))
}

#[cfg(test)]
mod tests {
    use super::{TransferProgress, format_bytes};
    use std::time::Duration;

    #[test]
    fn transfer_progress_reports_ratio() {
        let progress = TransferProgress::new(50, Some(200), Duration::from_secs(2));

        assert_eq!(progress.ratio(), Some(0.25));
        assert_eq!(progress.bytes_per_second(), Some(25.0));
    }

    #[test]
    fn transfer_progress_formats_summary_with_known_size() {
        let progress = TransferProgress::new(1024, Some(2048), Duration::from_secs(1));

        assert_eq!(progress.summary(), " 50.0%  1.0 KB / 2.0 KB  1.0 KB/s");
    }

    #[test]
    fn bytes_use_human_units() {
        assert_eq!(format_bytes(42), "42 B");
        assert_eq!(format_bytes(1536), "1.5 KB");
    }
}