Struct youtube_dl::YoutubeDl

pub struct YoutubeDl { /* private fields */ }

A builder to create a youtube-dl command to execute.

Implementations

impl YoutubeDl

pub fn new(url: impl Into<String>) -> Self

Create a new builder.

pub fn search_for(options: &SearchOptions) -> Self

Performs a search with the given search options.

pub fn youtube_dl_path<P: AsRef<Path>>( &mut self, youtube_dl_path: P ) -> &mut Self

Set the path to the youtube-dl or `yt-dlp executable.

pub fn format<S: Into<String>>(&mut self, format: S) -> &mut Self

Set the -f command line option.

pub fn flat_playlist(&mut self, flat_playlist: bool) -> &mut Self

Set the --flat-playlist command line flag.

pub fn socket_timeout<S: Into<String>>( &mut self, socket_timeout: S ) -> &mut Self

Set the --socket-timeout command line flag.

pub fn user_agent<S: Into<String>>(&mut self, user_agent: S) -> &mut Self

Set the --user-agent command line flag.

pub fn playlist_reverse(&mut self, playlist_reverse: bool) -> &mut Self

Set the --playlist-reverse flag. Useful with break-on-reject and date_before for faster queries.

pub fn date<S: Into<String>>(&mut self, date_string: S) -> &mut Self

Sets the --date command line flag only downloading/viewing videos on this date

pub fn date_before<S: Into<String>>(&mut self, date_string: S) -> &mut Self

Set the --datebefore flag only downloading/viewing videos on or before this date

pub fn date_after<S: Into<String>>(&mut self, date_string: S) -> &mut Self

Set the --dateafter flag only downloading/viewing vidieos on or after this date

pub fn referer<S: Into<String>>(&mut self, referer: S) -> &mut Self

Set the --referer command line flag.

pub fn all_formats(&mut self, all_formats: bool) -> &mut Self

Set the --all-formats command line flag.

pub fn auth<S: Into<String>>(&mut self, username: S, password: S) -> &mut Self

Set the -u and -p command line flags.

pub fn cookies<S: Into<String>>(&mut self, cookie_path: S) -> &mut Self

Specify a file with cookies in Netscape cookie format.

pub fn cookies_from_browser<S: Into<String>>( &mut self, browser_name: S, browser_keyring: Option<S>, browser_profile: Option<S>, browser_container: Option<S> ) -> &mut Self

Set the --cookies-from-browser command line flag.

pub fn process_timeout(&mut self, timeout: Duration) -> &mut Self

Set a process-level timeout for youtube-dl. (this controls the maximum overall duration the process may take, when it times out, Error::ProcessTimeout is returned)

pub fn extract_audio(&mut self, extract_audio: bool) -> &mut Self

Set the --extract-audio command line flag.

pub fn playlist_items(&mut self, index: u32) -> &mut Self

Set the --playlist-items command line flag.

pub fn max_downloads(&mut self, max_downloads: u32) -> &mut Self

Set the --max-downloads command line flag.

pub fn extra_arg<S: Into<String>>(&mut self, arg: S) -> &mut Self

Add an additional custom CLI argument.

This allows specifying arguments that are not covered by other configuration methods.

pub fn output_template<S: Into<String>>(&mut self, arg: S) -> &mut Self

Specify the filename template. Only relevant for downloading. (referred to as “output template” by youtube-dl docs)

pub fn output_directory<S: Into<String>>(&mut self, arg: S) -> &mut Self

Specify the output directory. Only relevant for downloading. (the -P command line switch)

pub fn ignore_errors(&mut self, arg: bool) -> &mut Self

Specify whether to ignore errors (exit code & flag)

pub fn run(&self) -> Result<YoutubeDlOutput, Error>

Run yt-dlp with the arguments specified through the builder and parse its JSON ouput into YoutubeDlOutput. Note: This can fail when the JSON output is not compatible with the struct definitions in this crate.

pub fn run_raw(&self) -> Result<Value, Error>

Run yt-dlp with the arguments through the builder and parse its JSON output into a serde_json::Value. This is meant as a fallback for when the JSON output is not compatible with the struct definitions in this crate.

pub async fn run_async(&self) -> Result<YoutubeDlOutput, Error>

Run yt-dlp asynchronously with the arguments specified through the builder.

pub async fn run_raw_async(&self) -> Result<Value, Error>

Run yt-dlp asynchronously with the arguments through the builder and parse its JSON output into a serde_json::Value. This is meant as a fallback for when the JSON output is not compatible with the struct definitions in this crate.

pub fn download_to(&self, folder: impl AsRef<Path>) -> Result<(), Error>

Download the file to the specified destination folder.

pub async fn download_to_async( &self, folder: impl AsRef<Path> ) -> Result<(), Error>

Download the file to the specified destination folder asynchronously.

Trait Implementations

impl Clone for YoutubeDl

fn clone(&self) -> YoutubeDl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for YoutubeDl

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

Formats the value using the given formatter.