dnld 0.3.5

Rust library for simple downloading
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

#![doc = include_str!("../README.md")]

use {
    anyhow::Result,
    bytes::Buf,
    reqwest::Url,
    std::{
        fs::File,
        path::{Path, PathBuf},
    },
};

//--------------------------------------------------------------------------------------------------

/**
Wrapper around a blocking [`reqwest`] [`Client`] providing convenience methods
*/
pub struct Client {
    client: reqwest::blocking::Client,
}

impl Client {
    /**
    Create a new [`Client`] with the given user agent

    # Errors

    Returns an error if not able to create the inner [`reqwest::blocking::Client`]
    */
    pub fn new(user_agent: &str) -> Result<Client> {
        Ok(Client {
            client: reqwest::blocking::Client::builder()
                .user_agent(user_agent)
                .build()?,
        })
    }

    /**
    Download a URL and return the contents in a string

    # Errors

    Returns an error if not able to get the given URL and convert it to a string
    */
    pub fn to_string(&self, url: &str) -> Result<String> {
        Ok(self.client.get(url).send()?.text()?)
    }

    /**
    Download a URL to a file in the current or optional destination directory

    # Errors

    Returns an error if not able to get the given URL and save to the given file
    */
    pub fn to_file(&self, url: &str, dst: Option<&Path>) -> Result<PathBuf> {
        let res = self.client.get(url).send()?;

        let path = dst
            .and_then(|x| {
                if x.is_dir() {
                    Some(x.join(url_filename(res.url())))
                } else {
                    None
                }
            })
            .unwrap_or_else(|| PathBuf::from(url_filename(res.url())));

        std::io::copy(&mut res.bytes()?.reader(), &mut File::create(&path)?)?;

        Ok(path)
    }
}

//--------------------------------------------------------------------------------------------------

#[cfg(test)]
mod test {
    use super::*;
    use reqwest::Url;

    #[test]
    fn test_url_filename() {
        println!();
        for (url, filename) in [
            ("http://some.host.tld/path/to/file.ext", "file.ext"),
            ("http://some.host.tld/path/to/", "to"),
            ("http://some.host.tld/path/to", "to"),
            ("http://some.host.tld/path/", "path"),
            ("http://some.host.tld/path", "path"),
            ("http://some.host.tld/", "some.host.tld.html"),
            ("http://some.host.tld", "some.host.tld.html"),
        ] {
            println!("* {url:?} => {filename:?}");
            assert_eq!(url_filename(&Url::parse(url).unwrap()), *filename);
        }
    }
}

/**
Get the filename from a [`Url`]

* Last non-empty path segment
* If there are none, return the host with `.html` appended

```rust
use dnld::*;
use reqwest::Url;

for (url, filename) in [
    ("http://some.host.tld/path/to/file.ext", "file.ext"),
    ("http://some.host.tld/path/to/", "to"),
    ("http://some.host.tld/path/to", "to"),
    ("http://some.host.tld/path/", "path"),
    ("http://some.host.tld/path", "path"),
    ("http://some.host.tld/", "some.host.tld.html"),
    ("http://some.host.tld", "some.host.tld.html"),
] {
    assert_eq!(url_filename(&Url::parse(url).unwrap()), *filename);
}
```

# Panics

Panics if not able to get the filename or the host from the url
*/
#[must_use]
pub fn url_filename(url: &Url) -> String {
    url.path_segments()
        .and_then(|x| {
            for s in x.rev() {
                if !s.is_empty() {
                    return Some(s.to_string());
                }
            }
            None
        })
        .unwrap_or_else(|| format!("{}.html", url.host_str().unwrap()))
}