tetr_ch 0.8.0

A Rust wrapper for the TETRA CHANNEL 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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218

//! Models for the endpoints "User Leaderboard", "Historical User Leaderboard".
//!
//! - About the endpoint "User Leaderboard",
//!   see the [API document](https://tetr.io/about/api/#usersbyleaderboard).
//! - About the endpoint "Historical User Leaderboard",
//!   see the [API document](https://tetr.io/about/api/#usershistoryleaderboardseason).

use crate::model::{prelude::*, user::AchievementRatingCounts};

/// An array of users. (user leaderboard)
#[derive(Clone, Debug, Deserialize)]
#[non_exhaustive]
pub struct Leaderboard {
    /// The matched users.
    pub entries: Vec<LeaderboardUser>,
}

impl AsRef<Leaderboard> for Leaderboard {
    fn as_ref(&self) -> &Self {
        self
    }
}

/// User data in a user leaderboard.
/// This is used as an entry in the [`Leaderboard`] struct,
#[derive(Clone, Debug, Deserialize)]
#[non_exhaustive]
pub struct LeaderboardUser {
    /// The user's internal ID.
    #[serde(rename = "_id")]
    pub id: UserId,
    /// The user's username.
    pub username: String,
    /// The user's role.
    pub role: Role,
    /// When the user account was created.
    /// If not set, this account was created before join dates were recorded.
    #[serde(rename = "ts")]
    pub created_at: Option<Timestamp>,
    /// The user's XP in points.
    pub xp: f64,
    /// The user's ISO 3166-1 country code, or `None` if hidden/unknown.
    /// Some vanity flags exist.
    pub country: Option<String>,
    /// Whether this user is currently supporting TETR.IO <3
    #[serde(rename = "supporter")]
    #[serde(default)] // If the field is missing, it is false.
    pub is_supporter: bool,
    /// This user's current TETRA LEAGUE standing.
    pub league: PartialLeagueData,
    /// The amount of online games played by this user.
    /// If the user has chosen to hide this statistic, it will be -1.
    #[serde(rename = "gamesplayed")]
    pub online_games_played: i32,
    /// The amount of online games won by this user.
    /// If the user has chosen to hide this statistic, it will be -1.
    #[serde(rename = "gameswon")]
    pub online_games_won: i32,
    /// The amount of seconds this user spent playing, both on- and offline.
    /// If the user has chosen to hide this statistic, it will be -1.
    #[serde(rename = "gametime")]
    pub game_time: f64,
    /// This user's Achievement Rating.
    #[serde(rename = "ar")]
    pub achievement_rating: i32,
    /// The breakdown of the source of this user's Achievement Rating.
    #[serde(rename = "ar_counts")]
    pub achievement_rating_counts: AchievementRatingCounts,
    /// The prisecter of this entry.
    ///
    /// A **prisecter** is consisting of three floats.
    /// It allows you to continue paginating.
    #[serde(rename = "p")]
    pub prisecter: Prisecter,
}

impl LeaderboardUser {
    impl_get_user!(id);
    impl_for_xp!();
    impl_for_username!();
    impl_for_role!();
    impl_for_account_created_at!();
    impl_for_country!();
}

impl AsRef<LeaderboardUser> for LeaderboardUser {
    fn as_ref(&self) -> &Self {
        self
    }
}

/// Partial summary of a user's TETRA LEAGUE standing.
/// This is used in the [`LeaderboardUser`] struct,
#[derive(Clone, Debug, Deserialize)]
#[non_exhaustive]
pub struct PartialLeagueData {
    /// The amount of TETRA LEAGUE games played by this user.
    #[serde(rename = "gamesplayed")]
    pub games_played: u32,
    /// The amount of TETRA LEAGUE games won by this user.
    #[serde(rename = "gameswon")]
    pub games_won: u32,
    /// This user's TR (Tetra Rating).
    pub tr: f64,
    /// This user's GLIXARE.
    pub gxe: f64,
    /// This user's rank.
    pub rank: Rank,
    /// This user's highest achieved rank this season.
    ///
    /// ***The API document does not say this field is optional.**
    #[serde(rename = "bestrank")]
    pub best_rank: Option<Rank>,
    /// This user's Glicko-2 rating.
    pub glicko: f64,
    /// This user's Glicko-2 Rating Deviation.
    ///
    /// ***The API document does not say this field is optional.**
    pub rd: Option<f64>,
    /// This user's average APM (attack per minute) over the last 10 games.
    ///
    /// ***The API document does not say this field is optional.**
    pub apm: Option<f64>,
    /// This user's average PPS (pieces per second) over the last 10 games.
    ///
    /// ***The API document does not say this field is optional.**
    pub pps: Option<f64>,
    /// This user's average VS (versus score) over the last 10 games.
    ///
    /// ***The API document does not say this field is optional.**
    pub vs: Option<f64>,
    /// Whether this user's RD is rising (has not played in the last week).
    #[serde(rename = "decaying")]
    pub is_decaying: bool,
}

impl AsRef<PartialLeagueData> for PartialLeagueData {
    fn as_ref(&self) -> &Self {
        self
    }
}

/// An array of historical user blobs. (user leaderboard)
#[derive(Clone, Debug, Deserialize)]
#[non_exhaustive]
pub struct HistoricalLeaderboard {
    /// The matched historical user blobs.
    pub entries: Vec<PastUserWithPrisecter>,
}

impl AsRef<HistoricalLeaderboard> for HistoricalLeaderboard {
    fn as_ref(&self) -> &Self {
        self
    }
}

/// Past season final placement information of a user, with a [`Prisecter`].
/// This is used as an entry in the [`HistoricalLeaderboard`] struct,
#[derive(Clone, Debug, Deserialize)]
#[non_exhaustive]
pub struct PastUserWithPrisecter {
    /// The user's internal ID.
    #[serde(rename = "_id")]
    pub id: UserId,
    /// The season ID.
    pub season: String,
    /// The username the user had at the time.
    pub username: String,
    /// The country the user represented at the time.
    pub country: Option<String>,
    /// This user's final position in the season's global leaderboards.
    pub placement: i32,
    /// Whether the user was ranked at the time of the season's end.
    #[serde(rename = "ranked")]
    pub is_ranked: bool,
    /// The amount of TETRA LEAGUE games played by this user.
    #[serde(rename = "gamesplayed")]
    pub games_played: u32,
    /// The amount of TETRA LEAGUE games won by this user.
    #[serde(rename = "gameswon")]
    pub games_won: u32,
    /// This user's final Glicko-2 rating.
    pub glicko: f64,
    /// This user's final Glicko-2 Rating Deviation.
    pub rd: f64,
    /// This user's final TR (Tetra Rating).
    pub tr: f64,
    /// This user's final GLIXARE score (a % chance of beating an average player).
    pub gxe: f64,
    /// This user's final letter rank. z is unranked.
    pub rank: Rank,
    /// This user's highest achieved rank in the season.
    #[serde(rename = "bestrank")]
    pub best_rank: Option<Rank>,
    /// This user's average APM (attack per minute) over the last 10 games in the season.
    pub apm: f64,
    /// This user's average PPS (pieces per second) over the last 10 games in the season.
    pub pps: f64,
    /// This user's average VS (versus score) over the last 10 games in the season.
    pub vs: f64,
    /// The prisecter of this entry.
    ///
    /// A **prisecter** is consisting of three floats.
    /// It allows you to continue paginating.
    #[serde(rename = "p")]
    pub prisecter: Prisecter,
}

impl PastUserWithPrisecter {
    impl_get_user!(id);
    impl_for_country!();
}

impl AsRef<PastUserWithPrisecter> for PastUserWithPrisecter {
    fn as_ref(&self) -> &Self {
        self
    }
}