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

//! Models for the endpoint "Labs League Ranks".
//!
//! About the endpoint "Labs League Ranks",
//! see the [API document](https://tetr.io/about/api/#labsleagueranks).

use crate::model::prelude::*;

/// A view over all TETRA LEAGUE ranks and their metadata.
#[derive(Clone, Debug, Deserialize)]
#[non_exhaustive]
pub struct LabsLeagueRanks {
    /// The internal ID of the Labs data point.
    #[serde(rename = "_id")]
    pub id: String,
    /// The stream ID the Labs data point belongs to.
    #[serde(rename = "s")]
    pub stream_id: String,
    /// The time at which the data point was created.
    #[serde(rename = "t")]
    pub created_at: String,
    /// The data point.
    pub data: LeagueRanksData,
}

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

/// A data point.
///
/// If there are any unwrapped ranks,
/// please [create an Issue on GitHub](https://github.com/Rinrin0413/tetr-ch-rs/issues/new).
#[derive(Clone, Debug, Deserialize)]
#[non_exhaustive]
pub struct LeagueRanksData {
    /// The total amount of players.
    pub total: u32,
    /// The data of the X+ rank.
    #[serde(rename = "x+")]
    pub rank_x_plus: RankData,
    /// The data of the X rank.
    #[serde(rename = "x")]
    pub rank_x: RankData,
    /// The data of the U rank.
    #[serde(rename = "u")]
    pub rank_u: RankData,
    /// The data of the SS rank.
    #[serde(rename = "ss")]
    pub rank_ss: RankData,
    /// The data of the S+ rank.
    #[serde(rename = "s+")]
    pub rank_s_plus: RankData,
    /// The data of the S rank.
    #[serde(rename = "s")]
    pub rank_s: RankData,
    /// The data of the S- rank.
    #[serde(rename = "s-")]
    pub rank_s_minus: RankData,
    /// The data of the A+ rank.
    #[serde(rename = "a+")]
    pub rank_a_plus: RankData,
    /// The data of the A rank.
    #[serde(rename = "a")]
    pub rank_a: RankData,
    /// The data of the A- rank.
    #[serde(rename = "a-")]
    pub rank_a_minus: RankData,
    /// The data of the B+ rank.
    #[serde(rename = "b+")]
    pub rank_b_plus: RankData,
    /// The data of the B rank.
    #[serde(rename = "b")]
    pub rank_b: RankData,
    /// The data of the B- rank.
    #[serde(rename = "b-")]
    pub rank_b_minus: RankData,
    /// The data of the C+ rank.
    #[serde(rename = "c+")]
    pub rank_c_plus: RankData,
    /// The data of the C rank.
    #[serde(rename = "c")]
    pub rank_c: RankData,
    /// The data of the C- rank.
    #[serde(rename = "c-")]
    pub rank_c_minus: RankData,
    /// The data of the D+ rank.
    #[serde(rename = "d+")]
    pub rank_d_plus: RankData,
    /// The data of the D rank.
    #[serde(rename = "d")]
    pub rank_d: RankData,
}

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

/// A rank's data.
#[derive(Clone, Debug, Deserialize)]
#[non_exhaustive]
pub struct RankData {
    /// The leaderboard position required to attain this rank.
    #[serde(rename = "pos")]
    pub position: u32,
    /// The percentile (0~1) this rank is for.
    pub percentile: f64,
    /// The TR required to obtain a leaderboard position that will award this rank.
    #[serde(rename = "tr")]
    pub tr: f64,
    /// The TR this rank will gravitate toward (using de- and inflation zones).
    #[serde(rename = "targettr")]
    pub target_tr: f64,
    /// The average APM across all players in this rank.
    pub apm: Option<f64>,
    /// The average PPS across all players in this rank.
    pub pps: Option<f64>,
    /// The average Versus Score across all players in this rank.
    pub vs: Option<f64>,
    /// The amount of players with this rank.
    pub count: u32,
}

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