am-api 1.1.0

A library for interfacing with the Apple Music 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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

//! Library search

use crate::error::Error;
use crate::request::builder::MusicRequestBuilder;
use crate::request::context::ContextContainer;
use crate::resource::library::album::LibraryAlbum;
use crate::resource::library::artist::LibraryArtist;
use crate::resource::library::music_video::LibraryMusicVideo;
use crate::resource::library::playlist::LibraryPlaylist;
use crate::resource::library::song::LibrarySong;
use crate::resource::relationship::Relationship;
use crate::resource::ErrorResponse;
use crate::ApiClient;
use am_api_proc_macro::Context;
use serde::{Deserialize, Serialize};
use std::fmt::{Display, Formatter};
use std::sync::Arc;

/// Library search
pub struct LibrarySearch;

/// Library search request builder marker
pub struct LibrarySearchRequestBuilderMarker;

/// Library search request builder
pub type LibrarySearchRequestBuilder<'a> =
    MusicRequestBuilder<'a, LibrarySearchRequestBuilderMarker>;

impl<'a> LibrarySearchRequestBuilder<'a> {
    /// Search the library using a query
    ///
    /// # Params
    ///
    /// * types - types to search
    ///
    /// * term - The entered text for the search, spaces will automatically get replaced with '+'
    pub async fn search(
        mut self,
        client: &ApiClient,
        types: &[LibrarySearchType],
        term: &str,
    ) -> Result<LibrarySearchResults, Error> {
        let mut request_context = self.get_request_context_drain(client);

        request_context.query.push((
            String::from("types"),
            types
                .iter()
                .map(|e| e.to_string())
                .collect::<Vec<_>>()
                .join(","),
        ));
        request_context
            .query
            .push((String::from("term"), term.to_string().replace(' ', "+")));

        let request_context = Arc::new(request_context);

        let response = client
            .get("/v1/me/library/search")
            .query(&request_context.query)
            .send()
            .await?;

        if !response.status().is_success() {
            let error_response: ErrorResponse = response.json().await?;
            return Err(Error::MusicError(error_response));
        }

        let mut response = response.json::<LibrarySearchResponse>().await?;
        response.results.set_context(request_context);
        Ok(response.results)
    }
}

/// Library search results
#[derive(Context, Serialize, Deserialize, Default, Debug, Clone, PartialEq, Eq, Hash)]
#[serde(default)]
pub struct LibrarySearchResults {
    /// Library albums
    #[serde(rename = "library-albums")]
    pub library_albums: Relationship<LibraryAlbum>,
    /// Library artists
    #[serde(rename = "library-artists")]
    pub library_artists: Relationship<LibraryArtist>,
    /// Library music videos
    #[serde(rename = "library-music-videos")]
    pub library_music_videos: Relationship<LibraryMusicVideo>,
    /// Library playlists
    #[serde(rename = "library-playlists")]
    pub library_playlists: Relationship<LibraryPlaylist>,
    /// Library songs
    #[serde(rename = "library-songs")]
    pub library_songs: Relationship<LibrarySong>,
}

/// Library search type
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum LibrarySearchType {
    /// Library albums
    LibraryAlbums,
    /// Library artists
    LibraryArtists,
    /// Library music videos
    LibraryMusicVideos,
    /// Library playlists
    LibraryPlaylists,
    /// Library songs
    LibrarySongs,
}

impl Display for LibrarySearchType {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let s = match self {
            LibrarySearchType::LibraryAlbums => "library-albums",
            LibrarySearchType::LibraryArtists => "library-artists",
            LibrarySearchType::LibraryMusicVideos => "library-music-videos",
            LibrarySearchType::LibraryPlaylists => "library-playlists",
            LibrarySearchType::LibrarySongs => "library-songs",
        };
        write!(f, "{}", s)
    }
}

/// Library search response
#[derive(Serialize, Deserialize)]
struct LibrarySearchResponse {
    /// Results
    results: LibrarySearchResults,
}