Struct youtube_dl::YoutubeDl

pub struct YoutubeDl { /* fields omitted */ }

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 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 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 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 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 run(&self) -> Result<YoutubeDlOutput, Error>

Run youtube-dl with the arguments specified through the builder.

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.