ytdown 0.4.0

A Rust library mirroring yt-dlp's core: extract, select, and download media. Ships with a companion CLI (ytdown-cli).
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

//! Error types for the crate.

/// All errors produced by this crate.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum Error {
    /// No registered extractor matches the URL.
    #[error("no extractor supports this URL: {0}")]
    UnsupportedUrl(String),
    /// Underlying HTTP failure.
    #[error("network error during {stage}: {source}")]
    Network {
        /// The operation that was in progress when the failure occurred.
        stage: &'static str,
        /// The underlying reqwest error.
        #[source]
        source: reqwest::Error,
    },
    /// The site responded but the expected data could not be extracted.
    #[error("extraction failed at {stage}: {message}")]
    Extraction {
        /// The extraction phase that failed.
        stage: &'static str,
        /// A human-readable description of what went wrong.
        message: String,
    },
    /// The media exists but cannot be accessed.
    #[error("media unavailable: {reason}")]
    Unavailable {
        /// The classified reason the media is unavailable.
        reason: UnavailableReason,
        /// The raw message reported by the site, if any.
        message: String,
    },
    /// JS cipher solving failed.
    #[error("cipher error: {0}")]
    Cipher(String),
    /// Requested format does not exist / no format matched the selector.
    #[error("no matching format: {0}")]
    FormatNotFound(String),
    /// Filesystem error during download.
    #[error("io error: {0}")]
    Io(#[from] std::io::Error),
    /// Postprocessing (ffmpeg) failure.
    #[error("postprocess error: {0}")]
    Postprocess(String),
}

/// Why media is unavailable.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum UnavailableReason {
    /// Removed, private, or never existed.
    Gone,
    /// Age-restricted and no authenticated client succeeded.
    AgeRestricted,
    /// Blocked in the request region.
    GeoBlocked,
    /// Live content (manifests not supported in v1).
    Live,
    /// Any other documented status from the site.
    Other,
}

impl std::fmt::Display for UnavailableReason {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let s = match self {
            UnavailableReason::Gone => "gone",
            UnavailableReason::AgeRestricted => "age-restricted",
            UnavailableReason::GeoBlocked => "geo-blocked",
            UnavailableReason::Live => "live",
            UnavailableReason::Other => "other",
        };
        f.write_str(s)
    }
}

/// Crate-wide result alias.
pub type Result<T> = std::result::Result<T, Error>;

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn error_display_is_useful() {
        let e = Error::UnsupportedUrl("https://example.com/x".into());
        assert!(e.to_string().contains("example.com"));
    }
}