netspd 0.1.1

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

//! Strongly-typed events emitted by the engine while a test runs.

use tokio::sync::mpsc;

use crate::errors::{EngineError, EngineResult};

use super::models::{LatencyStats, TestPhase, TestReport, TransferProgress, TransferStats};

/// Events streamed from the engine to any consumer (TUI, CLI, API).
///
/// Consumers never need string matching or magic numbers: every event is a
/// dedicated variant carrying typed payloads.
#[derive(Debug, Clone)]
pub enum EngineEvent {
    /// A new test phase began.
    PhaseStarted {
        /// The phase that just started.
        phase: TestPhase,
    },
    /// A single latency sample completed.
    PingSample {
        /// One-based sample index.
        sequence: u32,
        /// Measured round-trip time, in milliseconds.
        latency_ms: f64,
    },
    /// The ping phase finished with aggregated statistics.
    PingFinished {
        /// Final latency statistics.
        stats: LatencyStats,
    },
    /// A live progress update for a download or upload.
    Progress {
        /// The current transfer snapshot.
        progress: TransferProgress,
    },
    /// A transfer phase finished with aggregated statistics.
    TransferFinished {
        /// The phase that finished.
        phase: TestPhase,
        /// Final transfer statistics.
        stats: TransferStats,
    },
    /// The entire test completed successfully.
    Finished {
        /// The complete report.
        report: TestReport,
    },
    /// The test failed and cannot continue.
    Failed {
        /// A human-readable description of the failure.
        message: String,
    },
}

/// Sends an event to the consumer.
///
/// A closed channel means the consumer went away, which the engine treats
/// as a cancellation rather than an error worth surfacing.
pub(crate) async fn emit(
    events: &mpsc::Sender<EngineEvent>,
    event: EngineEvent,
) -> EngineResult<()> {
    events.send(event).await.map_err(|_| EngineError::Cancelled)
}