netspd 0.1.7

A beautiful, modern, minimalistic network speed testing terminal application
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

//! Transfer metrics card: shared layout used by download and upload.

use ratatui::layout::Rect;
use ratatui::style::{Color, Modifier, Style};
use ratatui::text::{Line, Span};
use ratatui::widgets::{Block, Padding, Paragraph};
use ratatui::Frame;

use crate::app::state::TransferView;
use crate::tui::theme::Theme;
use crate::utils::format::{format_bps, format_bytes};

/// Identity and accent of a transfer card.
#[derive(Debug, Clone, Copy)]
pub struct CardStyle {
    /// Card title, e.g. `Download`.
    pub title: &'static str,
    /// Leading icon, e.g. `↓`.
    pub icon: &'static str,
    /// Accent color for the headline and active border.
    pub color: Color,
}

/// Renders one transfer card (used by the download and upload cards).
///
/// Shows the headline speed plus average, peak and transferred bytes.
/// `active` highlights the card while its phase is running.
pub fn render(
    frame: &mut Frame,
    area: Rect,
    theme: &Theme,
    style: CardStyle,
    view: &TransferView,
    active: bool,
) {
    if area.height == 0 {
        return;
    }
    let CardStyle { title, icon, color } = style;
    let colors = &theme.colors;
    let border_color = if active { color } else { colors.border };
    let block = Block::bordered()
        .border_set(crate::tui::glyphs::current().border)
        .border_style(Style::default().fg(border_color))
        .padding(Padding::horizontal(1))
        .title(Line::from(vec![
            Span::styled(format!(" {icon} "), Style::default().fg(color)),
            Span::styled(
                format!("{title} "),
                Style::default()
                    .fg(colors.text)
                    .add_modifier(Modifier::BOLD),
            ),
        ]));
    let inner = block.inner(area);
    frame.render_widget(block, area);

    let headline_bps = view
        .stats
        .map_or(view.current_bps, |stats| stats.average_bps);
    let headline = if started(view) {
        format_bps(headline_bps)
    } else {
        "—".to_owned()
    };

    let lines = vec![
        Line::from(Span::styled(
            headline,
            Style::default().fg(color).add_modifier(Modifier::BOLD),
        )),
        metric_line(
            colors.subtext,
            colors.text,
            "avg ",
            value_or_dash(view, view.average_bps),
        ),
        metric_line(
            colors.subtext,
            colors.text,
            "peak",
            value_or_dash(view, view.peak_bps),
        ),
        metric_line(
            colors.subtext,
            colors.text,
            "data",
            if view.bytes > 0 {
                format_bytes(view.bytes)
            } else {
                "—".to_owned()
            },
        ),
    ];
    frame.render_widget(Paragraph::new(lines), inner);
}

/// Renders the download card.
pub fn render_download(
    frame: &mut Frame,
    area: Rect,
    theme: &Theme,
    view: &TransferView,
    active: bool,
) {
    render(
        frame,
        area,
        theme,
        CardStyle {
            title: "Download",
            icon: crate::tui::glyphs::current().down,
            color: theme.colors.download,
        },
        view,
        active,
    );
}

/// Renders the upload card.
pub fn render_upload(
    frame: &mut Frame,
    area: Rect,
    theme: &Theme,
    view: &TransferView,
    active: bool,
) {
    render(
        frame,
        area,
        theme,
        CardStyle {
            title: "Upload",
            icon: crate::tui::glyphs::current().up,
            color: theme.colors.upload,
        },
        view,
        active,
    );
}

/// Whether the phase has produced any data yet.
fn started(view: &TransferView) -> bool {
    view.bytes > 0 || view.stats.is_some()
}

/// Formats a speed metric, or an em dash before the phase starts.
fn value_or_dash(view: &TransferView, bps: f64) -> String {
    if started(view) {
        format_bps(bps)
    } else {
        "—".to_owned()
    }
}

/// One `label value` metric row.
fn metric_line(
    label_color: Color,
    value_color: Color,
    label: &str,
    value: String,
) -> Line<'static> {
    Line::from(vec![
        Span::styled(format!("{label}  "), Style::default().fg(label_color)),
        Span::styled(value, Style::default().fg(value_color)),
    ])
}