ferrispot 0.2.1

A wrapper for the Spotify Web API
Documentation

Ferrispot

A wrapper for the Spotify Web API that (hopefully) doesn't suck (too much) (I think).

A lot of the functionality is largely opinionated for my own use. So far only the endpoints I care about are implemented.

Features

  • Type-safe clients and model.
  • Asynchronous and synchronous (blocking) clients.
  • Every OAuth authorization flow Spotify supports is implemented.
  • Supports multiple simultaneous user clients.
  • Automatically refreshes access tokens when they expire, where applicable.
  • Reacts to API rate limits using either Tokio's or async-std's sleep functions at your discretion when using an asynchronous client. Synchronous clients block the running thread.

Crate feature flags

  • async (default): enable the asynchronous API.
  • sync: enable the synchronous API.
    • In case neither APIs are enabled (default-features = false), the crate only includes the object model structure with minimal dependencies on serde and thiserror.
  • tokio_sleep (default): react to API rate limits using Tokio's sleep function.
  • async_std_sleep: react to API rate limits using async-std's sleep function.
    • In case both tokio_sleep and async_std_sleep are enabled, Tokio's sleep function will be used.
    • In case neither are enabled, the library will return a rate limit error when it occurs.
    • These features are meaningless unless the async feature is also enabled.

Attribution

This crate draws a lot of inspiration from:

  • aspotify by Sabrina Jewson, licensed under the MIT license
  • rspotify by Ramsay Leung and Mario Ortiz Manero, licensed under the MIT license

License

Dual-licensed under MIT or Apache 2.0.