aspotify 0.2.0

Asynchronous client for the Spotify API
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

//! Everything relating to authorization for the Spotify endpoints.

pub mod auth_code_flow;
pub mod c_c_flow;

use crate::util::*;
pub use auth_code_flow::*;
pub use c_c_flow::*;
use serde::{Serialize, Deserialize};
use std::env::{self, VarError};
use std::ffi::OsStr;
use std::time::{Duration, Instant};

/// An object that holds your Spotify Client ID and Client Secret.
///
/// # Examples
/// ```no_run
/// # async {
/// use aspotify::ClientCredentials;
///
/// // Create from inside the program.
/// let credentials = ClientCredentials {
///     id: String::from("your client id here"),
///     secret: String::from("your client secret here")
/// };
///
/// // Create from environment variables
/// let credentials = ClientCredentials::from_env()
///     .expect("CLIENT_ID or CLIENT_SECRET environment variables not set");
///
/// // The above line is equivalent to:
/// let flow = ClientCredentials::from_env_vars("CLIENT_ID", "CLIENT_SECRET")
///     .expect("CLIENT ID or CLIENT_SECRET environment variables not set");
/// # };
/// ```
#[derive(Debug, Clone)]
pub struct ClientCredentials {
    pub id: String,
    pub secret: String,
}

impl ClientCredentials {
    /// Attempts to create a ClientCredentials by reading environment variables.
    pub fn from_env_vars<I: AsRef<OsStr>, S: AsRef<OsStr>>(
        client_id: I,
        client_secret: S,
    ) -> Result<Self, VarError> {
        Ok(Self {
            id: env::var(client_id)?,
            secret: env::var(client_secret)?,
        })
    }
    /// Attempts to create a ClientCredentials by reading the CLIENT_ID and CLIENT_SECRET
    /// environment variables.
    ///
    /// Equivalent to `ClientCredentials::from_env_vars("CLIENT_ID", "CLIENT_SECRET")`.
    pub fn from_env() -> Result<Self, VarError> {
        Self::from_env_vars("CLIENT_ID", "CLIENT_SECRET")
    }
}

/// An access token for the Spotify API.
///
/// Generate these with CCFlow or AuthCodeFlow.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AccessToken {
    #[serde(rename = "access_token")]
    pub token: String,
    #[serde(rename = "expires_in", with = "serde_instant_seconds")]
    pub expires: Instant,
}

impl Default for AccessToken {
    /// An already-expired token.
    fn default() -> Self {
        Self {
            token: String::new(),
            expires: Instant::now() - Duration::from_secs(1),
        }
    }
}