Struct aspotify::Client

pub struct Client {
    pub credentials: ClientCredentials,
    // some fields omitted
}

A client to the Spotify API.

By default it will use the client credentials flow to send requests to the Spotify API. The set_refresh_token and redirected methods tell it to use the authorization code flow instead.

Fields

credentials: ClientCredentials

Your Spotify client credentials.

Implementations

impl Client

Endpoint function namespaces.

pub const fn albums(&self) -> Albums<'_>

Album-related endpoints.

pub const fn artists(&self) -> Artists<'_>

Artist-related endpoints.

pub const fn browse(&self) -> Browse<'_>

Endpoint functions related to categories, featured playlists, recommendations, and new releases.

pub const fn episodes(&self) -> Episodes<'_>

Episode-related endpoints.

pub const fn follow(&self) -> Follow<'_>

Endpoint functions related to following and unfollowing artists, users and playlists.

pub const fn library(&self) -> Library<'_>

Endpoints relating to saving albums and tracks.

pub const fn personalization(&self) -> Personalization<'_>

Endpoint functions relating to a user’s top artists and tracks.

pub const fn player(&self) -> Player<'_>

Endpoint functions related to controlling what is playing on the current user’s Spotify account. (Beta)

pub const fn playlists(&self) -> Playlists<'_>

Endpoint functions related to playlists.

pub const fn search(&self) -> Search<'_>

Endpoint functions related to searches.

pub const fn shows(&self) -> Shows<'_>

Endpoint functions related to shows.

pub const fn tracks(&self) -> Tracks<'_>

Endpoint functions related to tracks and audio analysis.

pub const fn users_profile(&self) -> UsersProfile<'_>

Endpoint functions related to users’ profiles.

impl Client

pub fn new(credentials: ClientCredentials) -> Self

Create a new client from your Spotify client credentials.

pub fn with_refresh(
    credentials: ClientCredentials,
    refresh_token: String
) -> Self

Create a new client with your Spotify client credentials and a refresh token.

pub async fn refresh_token(&self) -> Option<String>

Get the client’s refresh token.

pub async fn set_refresh_token(&self, refresh_token: Option<String>)

Set the client’s refresh token.

pub async fn current_access_token(&self) -> (String, Instant)

Get the client’s access token values.

pub async fn set_current_access_token(&self, token: String, expires: Instant)

Explicitly override the client’s access token values. Useful if you acquire the access token elsewhere.

pub async fn redirected(
    &self,
    url: &str,
    state: &str
) -> Result<(), RedirectedError>

Set the refresh token from the URL the client was redirected to and the state that was used to send them there.

Use the authorization_url() function to generate the URL to which you can send the client to to generate the URL here.

Errors

Fails if the URL is invalid in some way, the state was incorrect for the URL or Spotify fails.

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.