Struct rustube::Stream

pub struct Stream {

    pub mime: Mime,
    pub codecs: Vec<String>,
    pub is_progressive: bool,
    pub includes_video_track: bool,
    pub includes_audio_track: bool,
    pub format_type: Option<FormatType>,
    pub approx_duration_ms: Option<u64>,
    pub audio_channels: Option<u8>,
    pub audio_quality: Option<AudioQuality>,
    pub audio_sample_rate: Option<u64>,
    pub average_bitrate: Option<u64>,
    pub bitrate: Option<u64>,
    pub color_info: Option<ColorInfo>,
    pub fps: u8,
    pub height: Option<u64>,
    pub high_replication: Option<bool>,
    pub index_range: Option<Range<u64>>,
    pub init_range: Option<Range<u64>>,
    pub is_otf: bool,
    pub itag: u64,
    pub last_modified: DateTime<Utc>,
    pub loudness_db: Option<f64>,
    pub projection_type: ProjectionType,
    pub quality: Quality,
    pub quality_label: Option<QualityLabel>,
    pub signature_cipher: SignatureCipher,
    pub width: Option<u64>,
    pub video_details: Arc<VideoDetails>,
    // some fields omitted
}

A downloadable video Stream, that contains all the important information.

Fields

mime: Mime

codecs: Vec<String>

is_progressive: bool

includes_video_track: bool

includes_audio_track: bool

format_type: Option<FormatType>

approx_duration_ms: Option<u64>

audio_channels: Option<u8>

audio_quality: Option<AudioQuality>

audio_sample_rate: Option<u64>

average_bitrate: Option<u64>

bitrate: Option<u64>

color_info: Option<ColorInfo>

fps: u8

height: Option<u64>

high_replication: Option<bool>

index_range: Option<Range<u64>>

init_range: Option<Range<u64>>

is_otf: bool

itag: u64

last_modified: DateTime<Utc>

loudness_db: Option<f64>

projection_type: ProjectionType

quality: Quality

quality_label: Option<QualityLabel>

signature_cipher: SignatureCipher

width: Option<u64>

video_details: Arc<VideoDetails>

Implementations

impl Stream

pub async fn download_with_callback(
    &self,
    callback: Callback
) -> Result<PathBuf>

This is supported on crate features stream and callback only.

Attempts to downloads the Streams resource. This will download the video to <video_id>.mp4 in the current working directory. Takes an Callback

pub async fn download_to_dir_with_callback<P: AsRef<Path>>(
    &self,
    dir: P,
    callback: Callback
) -> Result<PathBuf>

This is supported on crate features stream and callback only.

Attempts to downloads the Streams resource. This will download the video to <video_id>.mp4 in the provided directory. Takes an Callback

pub async fn download_to_with_callback<P: AsRef<Path>>(
    &self,
    path: P,
    callback: Callback
) -> Result<()>

This is supported on crate features stream and callback only.

Attempts to downloads the Streams resource. This will download the video to the provided file path. Takes an Callback

impl Stream

pub async fn content_length(&self) -> Result<u64>

This is supported on crate features stream and download only.

The content length of the video. If the content length was not included in the RawFormat, this method will make a HEAD request, to try to figure it out.

Errors:

• When the content length was not included in the RawFormat, and the request fails.

pub async fn download(&self) -> Result<PathBuf>

This is supported on crate features stream and download only.

Attempts to downloads the Streams resource. This will download the video to <video_id>.mp4 in the current working directory.

pub async fn download_to_dir<P: AsRef<Path>>(&self, dir: P) -> Result<PathBuf>

This is supported on crate features stream and download only.

Attempts to downloads the Streams resource. This will download the video to <video_id>.mp4 in the provided directory.

pub async fn download_to<P: AsRef<Path>>(&self, path: P) -> Result<()>

This is supported on crate features stream and download only.

Attempts to downloads the Streams resource. This will download the video to the provided file path.

impl Stream

pub fn blocking_download(&self) -> Result<PathBuf>

This is supported on crate features download and blocking and stream only.

A synchronous wrapper around Stream::download.

pub fn blocking_download_with_callback(
    &self,
    callback: Callback
) -> Result<PathBuf>

This is supported on crate features download and blocking and stream and callback only.

A synchronous wrapper around Stream::download_with_callback.

pub fn blocking_download_to_dir<P: AsRef<Path>>(
    &self,
    dir: P
) -> Result<PathBuf>

This is supported on crate features download and blocking and stream only.

A synchronous wrapper around Stream::download_to_dir.

pub fn blocking_download_to_dir_with_callback<P: AsRef<Path>>(
    &self,
    dir: P,
    callback: Callback
) -> Result<PathBuf>

This is supported on crate features download and blocking and stream and callback only.

A synchronous wrapper around Stream::download_to_dir_with_callback.

pub fn blocking_download_to<P: AsRef<Path>>(&self, path: P) -> Result<()>

This is supported on crate features download and blocking and stream only.

A synchronous wrapper around Stream::download_to.

pub fn blocking_download_to_with_callback<P: AsRef<Path>>(
    &self,
    path: P,
    callback: Callback
) -> Result<()>

This is supported on crate features download and blocking and stream and callback only.

A synchronous wrapper around Stream::download_to_with_callback.

pub fn blocking_content_length(&self) -> Result<u64>

This is supported on crate features download and blocking and stream only.

A synchronous wrapper around Stream::content_length.

Trait Implementations

impl Clone for Stream

This is supported on crate feature stream only.

fn clone(&self) -> Stream

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Stream

This is supported on crate feature stream only.

fn fmt(&self, __f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Stream

This is supported on crate feature stream only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Stream> for Stream

This is supported on crate feature stream only.

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for Stream

This is supported on crate feature stream only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.