updated documentation

This commit is contained in:
Nils Pukropp committed 2021-05-12 17:22:17 +02:00
1 parent 5b58834c9f
commit a9789a8342
2 files changed
+4 -4

No files matched your search

+3 -3
View File
@@ -3,6 +3,7 @@
This is a simple wrapper for [youtube-dl](https://youtube-dl.org/) in rust.
```rust
use ytd_rs::{YoutubeDL, ResultType, Arg};
// youtube-dl arguments quietly run process and to format the output
// one doesn't take any input and is an option, the other takes the desired output format as input
let args = vec![Arg::new("--quiet"), Arg::new_with_arg("--output", "%(title).90s.%(ext)s")];
@@ -14,11 +15,10 @@ let download = ytd.download();
// check what the result is and print out the path to the download or the error
match download.result_type() {
ResultType::SUCCESS => println!("Your download: {}", download.output_dir().to_string());
ResultType::SUCCESS => println!("Your download: {}", download.output_dir().to_string_lossy()),
ResultType::IOERROR | ResultType::FAILURE =>
println!("Couldn't start download: {}", download.output());
println!("Couldn't start download: {}", download.output()),
};
```
+1 -1
View File
@@ -84,7 +84,7 @@ impl Display for Arg {
/// Structure that represents a youtube-dl task.
///
/// Every task needs a download location [`path`], a list of ['Arg'] that can be empty
/// Every task needs a download location, a list of ['Arg'] that can be empty
/// and a ['link'] to the desired source.
#[derive(Clone, Debug)]
pub struct YoutubeDL {