rustube 0.2.3

A YouTube video downloader, originally inspired by pytube, written in Rust.
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

use std::ops::{Deref, DerefMut};

use url::Url;

use crate::{IdBuf, Result, Stream};
use crate::video::Video as AsyncVideo;

/// A synchronous wrapper around [`Video`](crate::Video).
#[derive(Clone, Debug, derive_more::Display, PartialEq)]
pub struct Video(pub(super) AsyncVideo);

impl Video {
    /// A synchronous wrapper around [`Video::form_url`](crate::Video::from_url).
    /// 
    /// Creates a [`Video`] from an [`Url`].
    /// ### Errors
    /// - When [`VideoFetcher::from_url`](crate::VideoFetcher::from_url) fails.
    /// - When [`VideoFetcher::fetch`](crate::VideoFetcher::fetch) fails.
    /// - When [`VideoDescrambler::descramble`](crate::VideoDescrambler::descramble) fails.
    #[inline]
    pub fn from_url(url: &Url) -> Result<Self> {
        Ok(Self(block!(AsyncVideo::from_url(url))?))
    }


    /// A synchronous wrapper around [`Video::form_id`](crate::Video::from_id).
    ///
    /// Creates a [`Video`] from an [`Id`](crate::Id).
    /// ### Errors
    /// - When [`VideoFetcher::fetch`](crate::VideoFetcher::fetch) fails.
    /// - When [`VideoDescrambler::descramble`](crate::VideoDescrambler::descramble) fails.
    #[inline]
    pub fn from_id(id: IdBuf) -> Result<Self> {
        Ok(Self(block!(AsyncVideo::from_id(id))?))
    }

    /// Takes all [`Stream`]s of the video.
    #[inline]
    pub fn into_streams(self) -> Vec<Stream> {
        self.0.streams
    }
}

impl Deref for Video {
    type Target = AsyncVideo;

    #[inline]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl DerefMut for Video {
    #[inline]
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}