odl 0.5.1

flexible download library and CLI intended to be fast, reliable, and easy to use.
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

use keyring;
use secrecy::{ExposeSecret, SecretString};
use std::fmt;

#[derive(Clone)]
pub struct Credentials {
    username: String,
    password: Option<SecretString>,
}

impl PartialEq for Credentials {
    fn eq(&self, other: &Self) -> bool {
        self.username == other.username
        // no need for constant time comparisons, not sensitive context
            && self.password.as_ref().map(|x| x.expose_secret()) == other.password.as_ref().map(|x| x.expose_secret())
    }
}

impl Eq for Credentials {}

impl fmt::Debug for Credentials {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Credentials")
            .field("username", &self.username)
            .field("password", &"***")
            .finish()
    }
}

impl Credentials {
    pub fn new(username: &str, password: Option<&str>) -> Credentials {
        Credentials {
            username: username.to_string(),
            password: password.map(SecretString::from),
        }
    }

    pub fn username(&self) -> &str {
        &self.username
    }

    pub fn password(&self) -> Option<&str> {
        if let Some(password) = &self.password {
            Some(password.expose_secret())
        } else {
            None
        }
    }

    /// Does nothing if credentials contain no password
    pub async fn save_to_keyring(&self, target: &str) -> Result<(), keyring::Error> {
        if let Some(password) = &self.password {
            let username = self.username.clone();
            let password = password.expose_secret().to_owned();
            let target = target.to_owned();

            // Spawn blocking task to avoid blocking async runtime
            let inner = tokio::task::spawn_blocking(move || {
                let entry = keyring::Entry::new_with_target(&target, "odl-rs", &username)?;
                entry.set_password(&password)
            })
            .await
            .map_err(|e| {
                keyring::Error::PlatformFailure(Box::new(std::io::Error::other(e.to_string())))
            })?;
            inner?;
        }
        Ok(())
    }

    /// If no entry exists, password will be None
    pub async fn load_from_keyring(username: &str, target: &str) -> Result<Self, keyring::Error> {
        let username = username.to_owned();
        let target = target.to_owned();
        let username_for_keyring = username.clone();

        let password = match tokio::task::spawn_blocking(move || {
            let entry = keyring::Entry::new_with_target(&target, "odl-rs", &username_for_keyring)?;
            entry.get_password()
        })
        .await
        .map_err(|e| {
            keyring::Error::PlatformFailure(Box::new(std::io::Error::other(e.to_string())))
        })? {
            Ok(pw) => Some(SecretString::from(pw)),
            Err(keyring::Error::NoEntry) => None,
            Err(e) => return Err(e),
        };

        Ok(Credentials { username, password })
    }
}