odl 1.0.0

flexible download library and CLI intended to be fast, reliable, and easy to use.
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

//! Machine-readable (NDJSON / JSON) output for `--format json`.
//!
//! Download progress is streamed as newline-delimited JSON objects on
//! stdout — one object per line, each tagged with a `type` field and the
//! owning `url` so an agent multiplexing several concurrent downloads can
//! attribute every event. Each `println!` writes one whole line under the
//! stdout lock, so lines from concurrent download tasks never interleave.
//!
//! One-shot commands (`config --show`, `probe`, `status`/`list`) emit a
//! single JSON document instead; those are built directly in `main`.

use odl::progress::{Phase, ProgressEvent, ProgressReporter};
use serde_json::json;

pub fn phase_str(phase: Phase) -> &'static str {
    match phase {
        Phase::Evaluating => "evaluating",
        Phase::ResolvingConflicts => "resolving_conflicts",
        Phase::Downloading => "downloading",
        Phase::Assembling => "assembling",
        Phase::Flushing => "flushing",
        Phase::Verifying => "verifying",
    }
}

/// Print one JSON value as a single NDJSON line on stdout.
pub fn emit_line(value: serde_json::Value) {
    println!("{value}");
}

/// `ProgressReporter` that emits NDJSON lifecycle events on stdout. One
/// instance per download; the `url` it was constructed with tags every
/// event. High-frequency, low-signal events (speed samples, per-part
/// progress) are intentionally dropped to keep the stream parseable —
/// aggregate `progress` events carry enough to derive throughput.
pub struct JsonReporter {
    url: String,
}

impl JsonReporter {
    pub fn new(url: String) -> Self {
        Self { url }
    }
}

impl ProgressReporter for JsonReporter {
    fn on_event(&self, event: ProgressEvent) {
        let url = &self.url;
        match event {
            ProgressEvent::FilenameResolved(name) => {
                emit_line(json!({"type": "filename", "url": url, "filename": name}));
            }
            ProgressEvent::PhaseChanged(phase) => {
                emit_line(json!({"type": "phase", "url": url, "phase": phase_str(phase)}));
            }
            ProgressEvent::Progress { downloaded, total } => {
                emit_line(json!({
                    "type": "progress",
                    "url": url,
                    "downloaded": downloaded,
                    "total": total,
                }));
            }
            ProgressEvent::Message(message) => {
                if !message.is_empty() {
                    emit_line(json!({"type": "message", "url": url, "message": message}));
                }
            }
            ProgressEvent::Completed {
                path,
                already_complete,
            } => {
                emit_line(json!({
                    "type": "completed",
                    "url": url,
                    "path": path.to_string_lossy(),
                    "already_complete": already_complete,
                }));
            }
            ProgressEvent::Cancelled => {
                emit_line(json!({"type": "cancelled", "url": url}));
            }
            ProgressEvent::Failed { message } => {
                emit_line(json!({"type": "failed", "url": url, "message": message}));
            }
            // Speed samples and per-part events are too noisy for the
            // line-oriented stream; aggregate progress is sufficient.
            ProgressEvent::Speed { .. }
            | ProgressEvent::PartAdded { .. }
            | ProgressEvent::PartProgress { .. }
            | ProgressEvent::PartFinished { .. }
            | ProgressEvent::PartSpeed { .. }
            | ProgressEvent::PartRetrying { .. } => {}
        }
    }
}