Struct rspotify::Token

pub struct Token {
    pub access_token: String,
    pub expires_in: TimeDelta,
    pub expires_at: Option<DateTime<Utc>>,
    pub refresh_token: Option<String>,
    pub scopes: HashSet<String>,
}

Spotify access token information

Reference

Fields

access_token: String

An access token that can be provided in subsequent calls

expires_in: TimeDelta

The time period for which the access token is valid.

expires_at: Option<DateTime<Utc>>

The valid time for which the access token is available represented in ISO 8601 combined date and time.

refresh_token: Option<String>

A token that can be sent to the Spotify Accounts service in place of an authorization code

scopes: HashSet<String>

A list of scopes which have been granted for this access_token

You may use the scopes! macro in rspotify-macros to build it at compile time easily.

Implementations

impl Token

pub fn from_cache<T>(path: T) -> Result<Token, ModelError>

where T: AsRef<Path>,

Tries to initialize the token from a cache file.

pub fn write_cache<T>(&self, path: T) -> Result<(), ModelError>

where T: AsRef<Path>,

Saves the token information into its cache file.

pub fn is_expired(&self) -> bool

Check if the token is expired. It includes a margin of 10 seconds (which is how much a request would take in the worst case scenario).

pub fn auth_headers(&self) -> HashMap<String, String>

Generates an HTTP token authorization header with proper formatting

Trait Implementations

impl Clone for Token

fn clone(&self) -> Token

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Token

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

Formats the value using the given formatter.

impl Default for Token

fn default() -> Token

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Token

fn deserialize<__D>( __deserializer: __D ) -> Result<Token, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Token

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Token

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Token

impl StructuralPartialEq for Token