Struct aspotify::ClientCredentials

pub struct ClientCredentials {
    pub id: String,
    pub secret: String,
}

An object that holds your Spotify Client ID and Client Secret.

See the Spotify guide on Spotify apps for how to get these.

Examples

use aspotify::ClientCredentials;

// Create from inside the program.
let credentials = ClientCredentials {
    id: "your client id here".to_owned(),
    secret: "your client secret here".to_owned()
};

// Create from CLIENT_ID and CLIENT_SECRET environment variables
let credentials = ClientCredentials::from_env()
    .expect("CLIENT_ID or CLIENT_SECRET environment variables not set");

// Or use custom env var names
let credentials = ClientCredentials::from_env_vars("SPOTIFY_ID", "SPOTIFY_SECRET")
    .expect("SPOTIFY_ID or SPOTIFY_SECRET environment variables not set");

Fields

id: String

The Client ID.

secret: String

The Client Secret.

Implementations

impl ClientCredentials

pub fn from_env_vars<I: AsRef<OsStr>, S: AsRef<OsStr>>(
    client_id: I,
    client_secret: S
) -> Result<Self, VarError>

Attempts to create a ClientCredentials by reading environment variables.

Errors

Fails if the environment variables are not present or are not unicode.

pub fn from_env() -> Result<Self, VarError>

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").

Errors

Fails if the environment variables are not present or are not unicode.

Trait Implementations

impl Clone for ClientCredentials

fn clone(&self) -> ClientCredentials

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClientCredentials

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<ClientCredentials> for ClientCredentials

fn eq(&self, other: &ClientCredentials) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ClientCredentials) -> bool

This method tests for !=.

impl Eq for ClientCredentials

impl StructuralEq for ClientCredentials

impl StructuralPartialEq for ClientCredentials