ncmapi 1.0.0

NetEase Cloud Music API for Rust.
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
143
144

//! Stable domain types returned by the supported SDK services.

use serde::Deserialize;

/// A response returned by the NetEase API.
///
/// The API keeps endpoint-specific fields beside `code`; those fields are
/// captured by the strongly typed `body` rather than exposed as unstructured
/// JSON.
#[derive(Clone, Debug, Deserialize)]
pub struct ApiResponse<T> {
    pub code: u16,
    #[serde(flatten)]
    pub body: T,
}

impl<T> ApiResponse<T> {
    /// Returns whether the remote service accepted the request.
    pub const fn is_success(&self) -> bool {
        self.code == 200
    }
}

/// A stable track identity.
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct TrackId(pub u64);

/// A stable user identity.
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct UserId(pub u64);

/// A compact artist projection shared by search and track results.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct Artist {
    pub id: u64,
    #[serde(default)]
    pub name: String,
}

/// A compact album projection shared by search and track results.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct Album {
    pub id: u64,
    #[serde(default)]
    pub name: String,
    #[serde(default)]
    pub pic_url: String,
}

/// Track metadata returned by search and library queries.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct Track {
    pub id: u64,
    #[serde(default)]
    pub name: String,
    #[serde(default, alias = "ar")]
    pub artists: Vec<Artist>,
    #[serde(default, alias = "al")]
    pub album: Album,
    #[serde(default, alias = "dt")]
    pub duration: u32,
}

/// The payload of a song search response.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
pub struct SearchBody {
    #[serde(default)]
    pub result: SearchResults,
}

/// Search results that are common across search modes.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct SearchResults {
    #[serde(default)]
    pub songs: Vec<Track>,
    #[serde(default)]
    pub has_more: bool,
}

/// The payload of a track-details response.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
pub struct TrackDetailsBody {
    #[serde(default)]
    pub songs: Vec<Track>,
}

/// A resolved playable stream.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
pub struct StreamUrl {
    pub id: u64,
    pub url: Option<String>,
    #[serde(default)]
    pub br: u32,
}

/// The payload of a stream URL response.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
pub struct StreamUrlsBody {
    #[serde(default)]
    pub data: Vec<StreamUrl>,
}

/// A user profile projection.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct UserProfile {
    pub user_id: u64,
    #[serde(default)]
    pub nickname: String,
}

/// The payload returned for the authenticated account.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
pub struct AccountBody {
    pub profile: Option<UserProfile>,
}

/// The payload returned for a public user profile.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
pub struct UserDetailsBody {
    pub profile: Option<UserProfile>,
}

/// A playlist projection.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
pub struct Playlist {
    pub id: u64,
    #[serde(default)]
    pub name: String,
    pub description: Option<String>,
}

/// The payload returned by a user's playlist query.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
pub struct UserPlaylistsBody {
    #[serde(default)]
    pub playlist: Vec<Playlist>,
}