Struct rspotify::auth_code_pkce::AuthCodePkceSpotify

pub struct AuthCodePkceSpotify {
    pub creds: Credentials,
    pub oauth: OAuth,
    pub config: Config,
    pub token: Arc<Mutex<Option<Token>>>,
    pub verifier: Option<String>,
    /* private fields */
}

The Authorization Code Flow with Proof Key for Code Exchange (PKCE) client for the Spotify API.

This flow is very similar to the regular Authorization Code Flow, so please read AuthCodeSpotify for more information about it. The main difference in this case is that you can avoid storing your client secret by generating a code verifier and a code challenge. However, note that the refresh token obtained with PKCE will only work to request the next one, after which it’ll become invalid.

There’s an example available to learn how to use this client.

Fields

creds: Credentials

oauth: OAuth

config: Config

token: Arc<Mutex<Option<Token>>>

verifier: Option<String>

The code verifier for the authentication process

Implementations

impl AuthCodePkceSpotify

pub fn new(creds: Credentials, oauth: OAuth) -> Self

Builds a new AuthCodePkceSpotify given a pair of client credentials and OAuth information.

pub fn from_token(token: Token) -> Self

Build a new AuthCodePkceSpotify from an already generated token. Note that once the token expires this will fail to make requests, as the client credentials aren’t known.

pub fn with_config(creds: Credentials, oauth: OAuth, config: Config) -> Self

Same as Self::new but with an extra parameter to configure the client.

pub fn get_authorize_url(
    &mut self,
    verifier_bytes: Option<usize>
) -> ClientResult<String>

Returns the URL needed to authorize the current client as the first step in the authorization flow.

The parameter verifier_bytes is the length of the randomly generated code verifier. Note that it must be between 43 and 128. If None is given, a length of 43 will be used by default. See the official docs or PKCE’s RFC for more information about the code verifier.

Trait Implementations

impl BaseClient for AuthCodePkceSpotify

This client has access to the base methods.

fn get_http(&self) -> &HttpClient

fn get_token(&self) -> Arc<Mutex<Option<Token>>>

Note that the token is wrapped by a Mutex in order to allow interior mutability. This is required so that the entire client doesn’t have to be mutable (the token is accessed to from every endpoint).

fn get_creds(&self) -> &Credentials

fn get_config(&self) -> &Config

fn refetch_token(&self) -> ClientResult<Option<Token>>

Refetch the current access token given a refresh token.

fn endpoint_url(&self, url: &str) -> String

If it’s a relative URL like “me”, the prefix is appended to it. Otherwise, the same URL is returned.

fn auto_reauth(&self) -> ClientResult<()>

Re-authenticate the client automatically if it’s configured to do so, which uses the refresh token to obtain a new access token.

fn refresh_token(&self) -> ClientResult<()>

Refreshes the current access token given a refresh token. The obtained token will be saved internally.

fn write_token_cache(&self) -> ClientResult<()>

Updates the cache file at the internal cache path.

fn fetch_access_token(
    &self,
    payload: &Form<'_>,
    headers: Option<&Headers>
) -> ClientResult<Token>

Sends a request to Spotify for an access token.

fn track(&self, track_id: &TrackId) -> ClientResult<FullTrack>

Returns a single track given the track’s ID, URI or URL.

fn tracks<'a>(
    &self,
    track_ids: impl IntoIterator<Item = &'a TrackId> + Send + 'a,
    market: Option<&Market>
) -> ClientResult<Vec<FullTrack>>

Returns a list of tracks given a list of track IDs, URIs, or URLs.

fn artist(&self, artist_id: &ArtistId) -> ClientResult<FullArtist>

Returns a single artist given the artist’s ID, URI or URL.

fn artists<'a>(
    &self,
    artist_ids: impl IntoIterator<Item = &'a ArtistId> + Send + 'a
) -> ClientResult<Vec<FullArtist>>

Returns a list of artists given the artist IDs, URIs, or URLs.

fn artist_albums<'a>(
    &'a self,
    artist_id: &'a ArtistId,
    album_type: Option<&'a AlbumType>,
    market: Option<&'a Market>
) -> Paginator<'_, ClientResult<SimplifiedAlbum>>

Get Spotify catalog information about an artist’s albums.

fn artist_albums_manual(
    &self,
    artist_id: &ArtistId,
    album_type: Option<&AlbumType>,
    market: Option<&Market>,
    limit: Option<u32>,
    offset: Option<u32>
) -> ClientResult<Page<SimplifiedAlbum>>

The manually paginated version of Self::artist_albums.

fn artist_top_tracks(
    &self,
    artist_id: &ArtistId,
    market: &Market
) -> ClientResult<Vec<FullTrack>>

Get Spotify catalog information about an artist’s top 10 tracks by country.

fn artist_related_artists(
    &self,
    artist_id: &ArtistId
) -> ClientResult<Vec<FullArtist>>

Get Spotify catalog information about artists similar to an identified artist. Similarity is based on analysis of the Spotify community’s listening history.

fn album(&self, album_id: &AlbumId) -> ClientResult<FullAlbum>

Returns a single album given the album’s ID, URIs or URL.

fn albums<'a>(
    &self,
    album_ids: impl IntoIterator<Item = &'a AlbumId> + Send + 'a
) -> ClientResult<Vec<FullAlbum>>

Returns a list of albums given the album IDs, URIs, or URLs.

fn search(
    &self,
    q: &str,
    _type: &SearchType,
    market: Option<&Market>,
    include_external: Option<&IncludeExternal>,
    limit: Option<u32>,
    offset: Option<u32>
) -> ClientResult<SearchResult>

Search for an Item. Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string.

fn album_track<'a>(
    &'a self,
    album_id: &'a AlbumId
) -> Paginator<'_, ClientResult<SimplifiedTrack>>

Get Spotify catalog information about an album’s tracks.

fn album_track_manual(
    &self,
    album_id: &AlbumId,
    limit: Option<u32>,
    offset: Option<u32>
) -> ClientResult<Page<SimplifiedTrack>>

The manually paginated version of Self::album_track.

fn user(&self, user_id: &UserId) -> ClientResult<PublicUser>

Gets basic profile information about a Spotify User.

fn playlist(
    &self,
    playlist_id: &PlaylistId,
    fields: Option<&str>,
    market: Option<&Market>
) -> ClientResult<FullPlaylist>

Get full details about Spotify playlist.

fn user_playlist(
    &self,
    user_id: &UserId,
    playlist_id: Option<&PlaylistId>,
    fields: Option<&str>
) -> ClientResult<FullPlaylist>

Gets playlist of a user.

fn playlist_check_follow(
    &self,
    playlist_id: &PlaylistId,
    user_ids: &[&UserId]
) -> ClientResult<Vec<bool>>

Check to see if the given users are following the given playlist.

fn get_a_show(
    &self,
    id: &ShowId,
    market: Option<&Market>
) -> ClientResult<FullShow>

Get Spotify catalog information for a single show identified by its unique Spotify ID.

fn get_several_shows<'a>(
    &self,
    ids: impl IntoIterator<Item = &'a ShowId> + Send + 'a,
    market: Option<&Market>
) -> ClientResult<Vec<SimplifiedShow>>

Get Spotify catalog information for multiple shows based on their Spotify IDs.

fn get_shows_episodes<'a>(
    &'a self,
    id: &'a ShowId,
    market: Option<&'a Market>
) -> Paginator<'_, ClientResult<SimplifiedEpisode>>

Get Spotify catalog information about an show’s episodes. Optional parameters can be used to limit the number of episodes returned.

fn get_shows_episodes_manual(
    &self,
    id: &ShowId,
    market: Option<&Market>,
    limit: Option<u32>,
    offset: Option<u32>
) -> ClientResult<Page<SimplifiedEpisode>>

The manually paginated version of Self::get_shows_episodes.

fn get_an_episode(
    &self,
    id: &EpisodeId,
    market: Option<&Market>
) -> ClientResult<FullEpisode>

Get Spotify catalog information for a single episode identified by its unique Spotify ID.

fn get_several_episodes<'a>(
    &self,
    ids: impl IntoIterator<Item = &'a EpisodeId> + Send + 'a,
    market: Option<&Market>
) -> ClientResult<Vec<FullEpisode>>

Get Spotify catalog information for multiple episodes based on their Spotify IDs.

fn track_features(&self, track_id: &TrackId) -> ClientResult<AudioFeatures>

Get audio features for a track

fn tracks_features<'a>(
    &self,
    track_ids: impl IntoIterator<Item = &'a TrackId> + Send + 'a
) -> ClientResult<Option<Vec<AudioFeatures>>>

Get Audio Features for Several Tracks

fn track_analysis(&self, track_id: &TrackId) -> ClientResult<AudioAnalysis>

Get Audio Analysis for a Track

fn categories<'a>(
    &'a self,
    locale: Option<&'a str>,
    country: Option<&'a Market>
) -> Paginator<'_, ClientResult<Category>>

Get a list of new album releases featured in Spotify

fn categories_manual(
    &self,
    locale: Option<&str>,
    country: Option<&Market>,
    limit: Option<u32>,
    offset: Option<u32>
) -> ClientResult<Page<Category>>

The manually paginated version of Self::categories.

fn category_playlists<'a>(
    &'a self,
    category_id: &'a str,
    country: Option<&'a Market>
) -> Paginator<'_, ClientResult<SimplifiedPlaylist>>

Get a list of playlists in a category in Spotify

fn category_playlists_manual(
    &self,
    category_id: &str,
    country: Option<&Market>,
    limit: Option<u32>,
    offset: Option<u32>
) -> ClientResult<Page<SimplifiedPlaylist>>

The manually paginated version of Self::category_playlists.

fn featured_playlists(
    &self,
    locale: Option<&str>,
    country: Option<&Market>,
    timestamp: Option<&DateTime<Utc>>,
    limit: Option<u32>,
    offset: Option<u32>
) -> ClientResult<FeaturedPlaylists>

Get a list of Spotify featured playlists.

fn new_releases<'a>(
    &'a self,
    country: Option<&'a Market>
) -> Paginator<'_, ClientResult<SimplifiedAlbum>>

Get a list of new album releases featured in Spotify.

fn new_releases_manual(
    &self,
    country: Option<&Market>,
    limit: Option<u32>,
    offset: Option<u32>
) -> ClientResult<Page<SimplifiedAlbum>>

The manually paginated version of Self::new_releases.

fn recommendations<'a>(
    &self,
    attributes: impl IntoIterator<Item = RecommendationsAttribute> + Send + 'a,
    seed_artists: Option<impl IntoIterator<Item = &'a ArtistId> + Send + 'a>,
    seed_genres: Option<impl IntoIterator<Item = &'a str> + Send + 'a>,
    seed_tracks: Option<impl IntoIterator<Item = &'a TrackId> + Send + 'a>,
    market: Option<&Market>,
    limit: Option<u32>
) -> ClientResult<Recommendations>

Get Recommendations Based on Seeds

fn playlist_items<'a>(
    &'a self,
    playlist_id: &'a PlaylistId,
    fields: Option<&'a str>,
    market: Option<&'a Market>
) -> Paginator<'_, ClientResult<PlaylistItem>>

Get full details of the items of a playlist owned by a user.

fn playlist_items_manual(
    &self,
    playlist_id: &PlaylistId,
    fields: Option<&str>,
    market: Option<&Market>,
    limit: Option<u32>,
    offset: Option<u32>
) -> ClientResult<Page<PlaylistItem>>

The manually paginated version of Self::playlist_items.

fn user_playlists<'a>(
    &'a self,
    user_id: &'a UserId
) -> Paginator<'_, ClientResult<SimplifiedPlaylist>>

Gets playlists of a user.

fn user_playlists_manual(
    &self,
    user_id: &UserId,
    limit: Option<u32>,
    offset: Option<u32>
) -> ClientResult<Page<SimplifiedPlaylist>>

The manually paginated version of Self::user_playlists.

impl Clone for AuthCodePkceSpotify

fn clone(&self) -> AuthCodePkceSpotify

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AuthCodePkceSpotify

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

Formats the value using the given formatter.

impl Default for AuthCodePkceSpotify

fn default() -> AuthCodePkceSpotify

Returns the “default value” for a type.

impl OAuthClient for AuthCodePkceSpotify

This client includes user authorization, so it has access to the user private endpoints in OAuthClient.

fn request_token(&mut self, code: &str) -> ClientResult<()>

Note that the code verifier must be set at this point, either manually or with Self::get_authorize_url. Otherwise, this function will panic.

fn get_oauth(&self) -> &OAuth

fn read_token_cache(
    &mut self,
    allow_expired: bool
) -> ClientResult<Option<Token>>

Tries to read the cache file’s token.

fn parse_response_code(&self, url: &str) -> Option<String>

Parse the response code in the given response url. If the URL cannot be parsed or the code parameter is not present, this will return None.

fn get_code_from_user(&self, url: &str) -> ClientResult<String>

Tries to open the authorization URL in the user’s browser, and returns the obtained code.

fn prompt_for_token(&mut self, url: &str) -> ClientResult<()>

Opens up the authorization URL in the user’s browser so that it can authenticate. It reads from the standard input the redirect URI in order to obtain the access token information. The resulting access token will be saved internally once the operation is successful.

fn current_user_playlists(
    &self
) -> Paginator<'_, ClientResult<SimplifiedPlaylist>>

Get current user playlists without required getting his profile.

fn current_user_playlists_manual(
    &self,
    limit: Option<u32>,
    offset: Option<u32>
) -> ClientResult<Page<SimplifiedPlaylist>>

The manually paginated version of Self::current_user_playlists.

fn user_playlist_create(
    &self,
    user_id: &UserId,
    name: &str,
    public: Option<bool>,
    collaborative: Option<bool>,
    description: Option<&str>
) -> ClientResult<FullPlaylist>

Creates a playlist for a user.

fn playlist_change_detail(
    &self,
    playlist_id: &PlaylistId,
    name: Option<&str>,
    public: Option<bool>,
    description: Option<&str>,
    collaborative: Option<bool>
) -> ClientResult<String>

Changes a playlist’s name and/or public/private state.

fn playlist_unfollow(&self, playlist_id: &PlaylistId) -> ClientResult<()>

Unfollows (deletes) a playlist for a user.

fn playlist_add_items<'a>(
    &self,
    playlist_id: &PlaylistId,
    items: impl IntoIterator<Item = &'a dyn PlayableId> + Send + 'a,
    position: Option<i32>
) -> ClientResult<PlaylistResult>

Adds items to a playlist.

fn playlist_replace_items<'a>(
    &self,
    playlist_id: &PlaylistId,
    items: impl IntoIterator<Item = &'a dyn PlayableId> + Send + 'a
) -> ClientResult<()>

Replace all items in a playlist

fn playlist_reorder_items(
    &self,
    playlist_id: &PlaylistId,
    range_start: Option<i32>,
    insert_before: Option<i32>,
    range_length: Option<u32>,
    snapshot_id: Option<&str>
) -> ClientResult<PlaylistResult>

Reorder items in a playlist.

fn playlist_remove_all_occurrences_of_items<'a>(
    &self,
    playlist_id: &PlaylistId,
    track_ids: impl IntoIterator<Item = &'a dyn PlayableId> + Send + 'a,
    snapshot_id: Option<&str>
) -> ClientResult<PlaylistResult>

Removes all occurrences of the given items from the given playlist.

fn playlist_remove_specific_occurrences_of_items<'a>(
    &self,
    playlist_id: &PlaylistId,
    items: impl IntoIterator<Item = ItemPositions<'a>> + Send + 'a,
    snapshot_id: Option<&str>
) -> ClientResult<PlaylistResult>

Removes specfic occurrences of the given items from the given playlist.

fn playlist_follow(
    &self,
    playlist_id: &PlaylistId,
    public: Option<bool>
) -> ClientResult<()>

Add the current authenticated user as a follower of a playlist.

fn me(&self) -> ClientResult<PrivateUser>

Get detailed profile information about the current user. An alias for the ‘current_user’ method.

fn current_user(&self) -> ClientResult<PrivateUser>

Get detailed profile information about the current user. An alias for the ‘me’ method.

fn current_user_playing_item(
    &self
) -> ClientResult<Option<CurrentlyPlayingContext>>

Get information about the current users currently playing item.

fn current_user_saved_albums<'a>(
    &'a self,
    market: Option<&'a Market>
) -> Paginator<'a, ClientResult<SavedAlbum>>

Gets a list of the albums saved in the current authorized user’s “Your Music” library

fn current_user_saved_albums_manual(
    &self,
    market: Option<&Market>,
    limit: Option<u32>,
    offset: Option<u32>
) -> ClientResult<Page<SavedAlbum>>

The manually paginated version of Self::current_user_saved_albums.

fn current_user_saved_tracks<'a>(
    &'a self,
    market: Option<&'a Market>
) -> Paginator<'a, ClientResult<SavedTrack>>

Get a list of the songs saved in the current Spotify user’s “Your Music” library.

fn current_user_saved_tracks_manual(
    &self,
    market: Option<&Market>,
    limit: Option<u32>,
    offset: Option<u32>
) -> ClientResult<Page<SavedTrack>>

The manually paginated version of Self::current_user_saved_tracks.

fn current_user_followed_artists(
    &self,
    after: Option<&str>,
    limit: Option<u32>
) -> ClientResult<CursorBasedPage<FullArtist>>

Gets a list of the artists followed by the current authorized user.

fn current_user_saved_tracks_delete<'a>(
    &self,
    track_ids: impl IntoIterator<Item = &'a TrackId> + Send + 'a
) -> ClientResult<()>

Remove one or more tracks from the current user’s “Your Music” library.

fn current_user_saved_tracks_contains<'a>(
    &self,
    track_ids: impl IntoIterator<Item = &'a TrackId> + Send + 'a
) -> ClientResult<Vec<bool>>

Check if one or more tracks is already saved in the current Spotify user’s “Your Music” library.

fn current_user_saved_tracks_add<'a>(
    &self,
    track_ids: impl IntoIterator<Item = &'a TrackId> + Send + 'a
) -> ClientResult<()>

Save one or more tracks to the current user’s “Your Music” library.

fn current_user_top_artists<'a>(
    &'a self,
    time_range: Option<&'a TimeRange>
) -> Paginator<'_, ClientResult<FullArtist>>

Get the current user’s top artists.

fn current_user_top_artists_manual(
    &self,
    time_range: Option<&TimeRange>,
    limit: Option<u32>,
    offset: Option<u32>
) -> ClientResult<Page<FullArtist>>

The manually paginated version of Self::current_user_top_artists.

fn current_user_top_tracks<'a>(
    &'a self,
    time_range: Option<&'a TimeRange>
) -> Paginator<'_, ClientResult<FullTrack>>

Get the current user’s top tracks.

fn current_user_top_tracks_manual(
    &self,
    time_range: Option<&TimeRange>,
    limit: Option<u32>,
    offset: Option<u32>
) -> ClientResult<Page<FullTrack>>

The manually paginated version of Self::current_user_top_tracks.

fn current_user_recently_played(
    &self,
    limit: Option<u32>,
    time_limit: Option<TimeLimits>
) -> ClientResult<CursorBasedPage<PlayHistory>>

Get the current user’s recently played tracks.

fn current_user_saved_albums_add<'a>(
    &self,
    album_ids: impl IntoIterator<Item = &'a AlbumId> + Send + 'a
) -> ClientResult<()>

Add one or more albums to the current user’s “Your Music” library.

fn current_user_saved_albums_delete<'a>(
    &self,
    album_ids: impl IntoIterator<Item = &'a AlbumId> + Send + 'a
) -> ClientResult<()>

Remove one or more albums from the current user’s “Your Music” library.

fn current_user_saved_albums_contains<'a>(
    &self,
    album_ids: impl IntoIterator<Item = &'a AlbumId> + Send + 'a
) -> ClientResult<Vec<bool>>

Check if one or more albums is already saved in the current Spotify user’s “Your Music” library.

fn user_follow_artists<'a>(
    &self,
    artist_ids: impl IntoIterator<Item = &'a ArtistId> + Send + 'a
) -> ClientResult<()>

Follow one or more artists.

fn user_unfollow_artists<'a>(
    &self,
    artist_ids: impl IntoIterator<Item = &'a ArtistId> + Send + 'a
) -> ClientResult<()>

Unfollow one or more artists.

fn user_artist_check_follow<'a>(
    &self,
    artist_ids: impl IntoIterator<Item = &'a ArtistId> + Send + 'a
) -> ClientResult<Vec<bool>>

Check to see if the current user is following one or more artists or other Spotify users.

fn user_follow_users<'a>(
    &self,
    user_ids: impl IntoIterator<Item = &'a UserId> + Send + 'a
) -> ClientResult<()>

Follow one or more users.

fn user_unfollow_users<'a>(
    &self,
    user_ids: impl IntoIterator<Item = &'a UserId> + Send + 'a
) -> ClientResult<()>

Unfollow one or more users.

fn device(&self) -> ClientResult<Vec<Device>>

Get a User’s Available Devices

fn current_playback<'a>(
    &self,
    country: Option<&Market>,
    additional_types: Option<impl IntoIterator<Item = &'a AdditionalType> + Send + 'a>
) -> ClientResult<Option<CurrentPlaybackContext>>

Get Information About The User’s Current Playback

fn current_playing<'a>(
    &self,
    market: Option<&'a Market>,
    additional_types: Option<impl IntoIterator<Item = &'a AdditionalType> + Send + 'a>
) -> ClientResult<Option<CurrentlyPlayingContext>>

Get the User’s Currently Playing Track

fn transfer_playback(
    &self,
    device_id: &str,
    play: Option<bool>
) -> ClientResult<()>

Transfer a User’s Playback.

fn start_context_playback<T: PlayContextId>(
    &self,
    context_uri: &T,
    device_id: Option<&str>,
    offset: Option<Offset>,
    position_ms: Option<Duration>
) -> ClientResult<()>

Start/Resume a User’s Playback.

fn start_uris_playback<'a>(
    &self,
    uris: impl IntoIterator<Item = &'a dyn PlayableId> + Send + 'a,
    device_id: Option<&str>,
    offset: Option<Offset>,
    position_ms: Option<u32>
) -> ClientResult<()>

Start a user’s playback

fn pause_playback(&self, device_id: Option<&str>) -> ClientResult<()>

Pause a User’s Playback.

fn resume_playback(
    &self,
    device_id: Option<&str>,
    position_ms: Option<u32>
) -> ClientResult<()>

Resume a User’s Playback.

fn next_track(&self, device_id: Option<&str>) -> ClientResult<()>

Skip User’s Playback To Next Track.

fn previous_track(&self, device_id: Option<&str>) -> ClientResult<()>

Skip User’s Playback To Previous Track.

fn seek_track(
    &self,
    position_ms: u32,
    device_id: Option<&str>
) -> ClientResult<()>

Seek To Position In Currently Playing Track.

fn repeat(
    &self,
    state: &RepeatState,
    device_id: Option<&str>
) -> ClientResult<()>

Set Repeat Mode On User’s Playback.

fn volume(
    &self,
    volume_percent: u8,
    device_id: Option<&str>
) -> ClientResult<()>

Set Volume For User’s Playback.

fn shuffle(&self, state: bool, device_id: Option<&str>) -> ClientResult<()>

Toggle Shuffle For User’s Playback.

fn add_item_to_queue<T: PlayableId>(
    &self,
    item: &T,
    device_id: Option<&str>
) -> ClientResult<()>

Add an item to the end of the user’s playback queue.

fn save_shows<'a>(
    &self,
    show_ids: impl IntoIterator<Item = &'a ShowId> + Send + 'a
) -> ClientResult<()>

Add a show or a list of shows to a user’s library.

fn get_saved_show(&self) -> Paginator<'_, ClientResult<Show>>

Get a list of shows saved in the current Spotify user’s library. Optional parameters can be used to limit the number of shows returned.

fn get_saved_show_manual(
    &self,
    limit: Option<u32>,
    offset: Option<u32>
) -> ClientResult<Page<Show>>

The manually paginated version of Self::get_saved_show.

fn check_users_saved_shows<'a>(
    &self,
    ids: impl IntoIterator<Item = &'a ShowId> + Send + 'a
) -> ClientResult<Vec<bool>>

Check if one or more shows is already saved in the current Spotify user’s library.

fn remove_users_saved_shows<'a>(
    &self,
    show_ids: impl IntoIterator<Item = &'a ShowId> + Send + 'a,
    country: Option<&Market>
) -> ClientResult<()>

Delete one or more shows from current Spotify user’s library. Changes to a user’s saved shows may not be visible in other Spotify applications immediately.