rocksky 0.1.0

Async Rust SDK for the Rocksky XRPC 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

//! `app.rocksky.album.*` — album views.

use serde::Serialize;

use crate::client::Client;
use crate::error::Result;
use crate::models::{Album, AlbumBasic, AlbumsEnvelope, SongBasic, TracksEnvelope};

#[derive(Debug)]
pub struct AlbumApi<'a> {
    client: &'a Client,
}

impl<'a> AlbumApi<'a> {
    pub(crate) fn new(client: &'a Client) -> Self {
        Self { client }
    }

    /// Detailed album view by AT-URI.
    pub async fn get(&self, uri: impl Into<String>) -> Result<Album> {
        #[derive(Serialize)]
        struct P {
            uri: String,
        }
        self.client
            .query_as("app.rocksky.album.getAlbum", &P { uri: uri.into() }, false)
            .await
    }

    /// List albums, optionally filtered.
    pub fn list(&self) -> ListAlbums<'_> {
        ListAlbums {
            client: self.client,
            params: ListParams::default(),
        }
    }

    /// Tracks on an album.
    pub async fn get_tracks(&self, uri: impl Into<String>) -> Result<Vec<SongBasic>> {
        #[derive(Serialize)]
        struct P {
            uri: String,
        }
        let env: TracksEnvelope = self
            .client
            .query_as("app.rocksky.album.getAlbumTracks", &P { uri: uri.into() }, false)
            .await?;
        Ok(env.tracks)
    }
}

#[derive(Debug, Default, Serialize)]
#[serde(rename_all = "camelCase")]
struct ListParams {
    #[serde(skip_serializing_if = "Option::is_none")]
    limit: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    offset: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    genre: Option<String>,
}

/// Builder for `app.rocksky.album.getAlbums`.
#[derive(Debug)]
pub struct ListAlbums<'a> {
    client: &'a Client,
    params: ListParams,
}

impl<'a> ListAlbums<'a> {
    pub fn limit(mut self, limit: u32) -> Self {
        self.params.limit = Some(limit);
        self
    }
    pub fn offset(mut self, offset: u32) -> Self {
        self.params.offset = Some(offset);
        self
    }
    pub fn genre(mut self, genre: impl Into<String>) -> Self {
        self.params.genre = Some(genre.into());
        self
    }
    pub async fn send(self) -> Result<Vec<AlbumBasic>> {
        let env: AlbumsEnvelope = self
            .client
            .query_as("app.rocksky.album.getAlbums", &self.params, false)
            .await?;
        Ok(env.albums)
    }
}