opensubsonic 0.3.0

Complete async Rust client for the OpenSubsonic/Subsonic REST 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
131
132
133
134
135
136
137
138
139
140
141
142

//! Searching API endpoints.

use crate::Client;
use crate::data::{SearchResult, SearchResult2, SearchResult3};
use crate::error::Error;

impl Client {
    /// Search (legacy, pre-1.4.0).
    ///
    /// See <https://opensubsonic.netlify.app/docs/endpoints/search/>
    #[allow(clippy::too_many_arguments)]
    pub async fn search(
        &self,
        artist: Option<&str>,
        album: Option<&str>,
        title: Option<&str>,
        any: Option<&str>,
        count: Option<i32>,
        offset: Option<i32>,
        newer_than: Option<i64>,
    ) -> Result<SearchResult, Error> {
        let mut params = Vec::new();
        if let Some(v) = artist {
            params.push(("artist", v.to_string()));
        }
        if let Some(v) = album {
            params.push(("album", v.to_string()));
        }
        if let Some(v) = title {
            params.push(("title", v.to_string()));
        }
        if let Some(v) = any {
            params.push(("any", v.to_string()));
        }
        if let Some(v) = count {
            params.push(("count", v.to_string()));
        }
        if let Some(v) = offset {
            params.push(("offset", v.to_string()));
        }
        if let Some(v) = newer_than {
            params.push(("newerThan", v.to_string()));
        }
        let param_refs: Vec<(&str, &str)> = params.iter().map(|(k, v)| (*k, v.as_str())).collect();
        let data = self.get_response("search", &param_refs).await?;
        let result = data
            .get("searchResult")
            .cloned()
            .unwrap_or_else(|| serde_json::Value::Object(serde_json::Map::new()));
        Ok(serde_json::from_value(result)?)
    }

    /// Search (folder-based, search2).
    ///
    /// See <https://opensubsonic.netlify.app/docs/endpoints/search2/>
    #[allow(clippy::too_many_arguments)]
    pub async fn search2(
        &self,
        query: &str,
        artist_count: Option<i32>,
        artist_offset: Option<i32>,
        album_count: Option<i32>,
        album_offset: Option<i32>,
        song_count: Option<i32>,
        song_offset: Option<i32>,
        music_folder_id: Option<&str>,
    ) -> Result<SearchResult2, Error> {
        let mut params = vec![("query", query.to_string())];
        if let Some(v) = artist_count {
            params.push(("artistCount", v.to_string()));
        }
        if let Some(v) = artist_offset {
            params.push(("artistOffset", v.to_string()));
        }
        if let Some(v) = album_count {
            params.push(("albumCount", v.to_string()));
        }
        if let Some(v) = album_offset {
            params.push(("albumOffset", v.to_string()));
        }
        if let Some(v) = song_count {
            params.push(("songCount", v.to_string()));
        }
        if let Some(v) = song_offset {
            params.push(("songOffset", v.to_string()));
        }
        if let Some(id) = music_folder_id {
            params.push(("musicFolderId", id.to_string()));
        }
        let param_refs: Vec<(&str, &str)> = params.iter().map(|(k, v)| (*k, v.as_str())).collect();
        let data = self.get_response("search2", &param_refs).await?;
        let result = data
            .get("searchResult2")
            .ok_or_else(|| Error::Parse("Missing 'searchResult2' in response".into()))?;
        Ok(serde_json::from_value(result.clone())?)
    }

    /// Search (ID3-based, search3).
    ///
    /// See <https://opensubsonic.netlify.app/docs/endpoints/search3/>
    #[allow(clippy::too_many_arguments)]
    pub async fn search3(
        &self,
        query: &str,
        artist_count: Option<i32>,
        artist_offset: Option<i32>,
        album_count: Option<i32>,
        album_offset: Option<i32>,
        song_count: Option<i32>,
        song_offset: Option<i32>,
        music_folder_id: Option<&str>,
    ) -> Result<SearchResult3, Error> {
        let mut params = vec![("query", query.to_string())];
        if let Some(v) = artist_count {
            params.push(("artistCount", v.to_string()));
        }
        if let Some(v) = artist_offset {
            params.push(("artistOffset", v.to_string()));
        }
        if let Some(v) = album_count {
            params.push(("albumCount", v.to_string()));
        }
        if let Some(v) = album_offset {
            params.push(("albumOffset", v.to_string()));
        }
        if let Some(v) = song_count {
            params.push(("songCount", v.to_string()));
        }
        if let Some(v) = song_offset {
            params.push(("songOffset", v.to_string()));
        }
        if let Some(id) = music_folder_id {
            params.push(("musicFolderId", id.to_string()));
        }
        let param_refs: Vec<(&str, &str)> = params.iter().map(|(k, v)| (*k, v.as_str())).collect();
        let data = self.get_response("search3", &param_refs).await?;
        let result = data
            .get("searchResult3")
            .ok_or_else(|| Error::Parse("Missing 'searchResult3' in response".into()))?;
        Ok(serde_json::from_value(result.clone())?)
    }
}