netspd 0.1.2

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

//! Command line interface definition.

use clap::Parser;

use crate::engine::providers::ProviderKind;

/// A beautiful network speed test for your terminal.
#[derive(Debug, Parser)]
#[command(name = "netspd", version, about)]
pub struct Cli {
    /// Speed test provider: librespeed, ookla or fast
    #[arg(long, short = 'p', value_name = "NAME")]
    pub provider: Option<ProviderKind>,

    /// Run headless: progress on stderr, summary on stdout
    #[arg(long)]
    pub no_tui: bool,

    /// Run headless and print the report as one JSON object on stdout
    #[arg(long)]
    pub json: bool,

    /// Pick a server whose name or host contains this text
    /// (case-insensitive)
    #[arg(long, short = 's', value_name = "TEXT")]
    pub server: Option<String>,

    /// List reachable servers (nearest first) and exit
    #[arg(long)]
    pub list_servers: bool,

    /// Override the duration of each transfer phase, in seconds (3-60)
    #[arg(long, short = 'd', value_name = "SECS")]
    pub duration: Option<u64>,

    /// Override the number of parallel connections (1-16)
    #[arg(long, short = 'c', value_name = "N")]
    pub connections: Option<usize>,
}

impl Cli {
    /// Whether any flag requests a run without the TUI.
    #[must_use]
    pub fn headless(&self) -> bool {
        self.no_tui || self.json || self.list_servers
    }
}