Struct rspotify::Config

pub struct Config {
    pub api_base_url: String,
    pub auth_base_url: String,
    pub cache_path: PathBuf,
    pub pagination_chunks: u32,
    pub token_cached: bool,
    pub token_refreshing: bool,
    pub token_callback_fn: Arc<Option<TokenCallback>>,
}

Struct to configure the Spotify client.

Fields

api_base_url: String

The Spotify API prefix, DEFAULT_API_BASE_URL by default.

auth_base_url: String

The Spotify Authentication prefix, DEFAULT_AUTH_BASE_URL by default.

cache_path: PathBuf

The cache file path, in case it’s used. By default it’s DEFAULT_CACHE_PATH

pagination_chunks: u32

The pagination chunk size used when performing automatically paginated requests, like artist_albums. This means that a request will be performed every pagination_chunks items. By default this is DEFAULT_PAGINATION_CHUNKS.

Note that most endpoints set a maximum to the number of items per request, which most times is 50.

token_cached: bool

Whether or not to save the authentication token into a JSON file, then reread the token from JSON file when launching the program without following the full auth process again

token_refreshing: bool

Whether or not to check if the token has expired when sending a request with credentials, and in that case, automatically refresh it.

token_callback_fn: Arc<Option<TokenCallback>>

Whenever client succeeds to request or refresh a token, the callback function will be invoked

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.