ferrispot 0.4.3

A wrapper for the Spotify Web API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

# Ferrispot

[![Crates.io](https://img.shields.io/crates/v/ferrispot)](https://crates.io/crates/ferrispot) [![docs.rs](https://img.shields.io/docsrs/ferrispot)](https://docs.rs/ferrispot/latest)

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 but I'm trying to make the library ergonomic and efficient to use. So far only the endpoints I care about are implemented, but if you need some endpoints implemented, feel free to open an issue.

## 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 API is 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.
-   `native-tls` (default): use native system TLS library for secure connections.
-   `rustls-tls`: use `rustls` for secure connections.

## Changelog

See [CHANGELOG.md](CHANGELOG.md).

## Attribution

This crate draws a lot of inspiration from:

-   [aspotify](https://github.com/SabrinaJewson/aspotify) by Sabrina Jewson, licensed under the MIT license
-   [rspotify](https://github.com/ramsayleung/rspotify) by Ramsay Leung and Mario Ortiz Manero, licensed under the MIT license

## License

Dual-licensed under [MIT](LICENSE-MIT) or [Apache 2.0](LICENSE-APACHE).