spotify-rs 0.4.1

A Rust wrapper for the Spotify 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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

use serde::Serialize;

use crate::{
    auth::AuthFlow,
    error::Result,
    model::search::{Item, SearchQuery, SearchResults},
    query_list,
};

use super::{Client, Endpoint};

impl Endpoint for SearchEndpoint {}

/// Search for an item. The query can be either a string or
/// [`SearchQuery`](crate::model::search::SearchQuery). More details about
/// search queries can be found
/// [here](https://developer.spotify.com/documentation/web-api/reference/search).
pub fn search(query: impl Into<SearchQuery>, item_types: &[Item]) -> SearchEndpoint {
    let r#type = query_list(item_types);
    let query = query.into().to_string();

    SearchEndpoint {
        query,
        r#type,
        ..Default::default()
    }
}

#[derive(Clone, Debug, Default, Serialize)]
pub struct SearchEndpoint {
    #[serde(rename = "q")]
    pub(crate) query: String,
    pub(crate) r#type: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub(crate) market: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub(crate) limit: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub(crate) offset: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub(crate) include_external: Option<bool>,
}

impl SearchEndpoint {
    #[doc = include_str!("../docs/market.md")]
    pub fn market(mut self, market: impl Into<String>) -> Self {
        self.market = Some(market.into());
        self
    }

    #[doc = include_str!("../docs/limit.md")]
    pub fn limit(mut self, limit: u32) -> Self {
        self.limit = Some(limit);
        self
    }

    #[doc = include_str!("../docs/offset.md")]
    pub fn offset(mut self, offset: u32) -> Self {
        self.offset = Some(offset);
        self
    }

    /// If specified, it signals that the client can play externally hosted audio content,
    /// and marks the content as playable in the response.
    ///
    /// By default externally hosted audio content is marked as unplayable in the response.
    pub fn include_external(mut self, include_external: bool) -> Self {
        self.include_external = Some(include_external);
        self
    }

    /// Allows you to change the types of items to search.
    pub fn item_types(mut self, item_types: &[Item]) -> Self {
        self.r#type = query_list(item_types);
        self
    }

    #[doc = include_str!("../docs/send.md")]
    pub async fn get(self, spotify: &Client<impl AuthFlow>) -> Result<SearchResults> {
        spotify.get("/search".to_owned(), self).await
    }
}