lichess-api 1.0.0

A client library for the Lichess 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

use crate::model::{PerfType, Request, Title};
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct PerfTypeData {
    pub key: String,
    pub name: String,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct User {
    pub name: String,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Glicko {
    pub rating: f64,
    pub deviation: f64,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub provisional: Option<bool>,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Perf {
    pub glicko: Glicko,

    #[serde(rename = "nb")]
    pub rated_games: u32,
    pub progress: i32,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Game {
    pub at: String,
    pub game_id: String,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct RatingExtreme {
    #[serde(rename = "int")]
    pub rating: u32,

    #[serde(flatten)]
    pub game: Game,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct UserId {
    pub id: String,
    pub name: String,
    pub title: Option<Title>,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct WinExtremeGame {
    #[serde(rename = "opRating")]
    pub opponent_rating: u32,

    #[serde(rename = "opId")]
    pub opponent: UserId,

    #[serde(flatten)]
    pub game: Game,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct WinExtremes {
    pub results: Vec<WinExtremeGame>,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Count {
    pub all: u32,
    pub rated: u32,
    pub win: u32,
    pub loss: u32,
    pub draw: u32,
    pub tour: u32,
    pub berserk: u32,
    pub op_avg: f64,
    pub seconds: u32,
    pub disconnects: u32,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase", untagged)]
pub enum Streak {
    Range { v: u32, from: Game, to: Game },
    Empty { v: u32 },
}

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct StreakSet {
    #[serde(rename = "cur")]
    pub current: Streak,
    pub max: Streak,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct ResultStreak {
    pub win: StreakSet,
    pub loss: StreakSet,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct PlayStreak {
    #[serde(rename = "nb")]
    pub game_count: StreakSet,
    pub time: StreakSet,
    pub last_date: String,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Stat {
    pub perf_type: PerfTypeData,
    pub id: String,
    pub highest: RatingExtreme,
    pub lowest: RatingExtreme,
    pub best_wins: WinExtremes,
    pub worst_losses: WinExtremes,
    pub count: Count,
    pub result_streak: ResultStreak,
    pub play_streak: PlayStreak,
    pub user_id: UserId,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct PerfStat {
    pub user: User,
    pub perf: Perf,
    pub rank: Option<u32>,
    pub percentile: Option<f64>,
    pub stat: Stat,
}

#[derive(Default, Clone, Debug, Serialize)]
pub struct GetQuery;

pub type GetRequest = Request<GetQuery>;

impl GetRequest {
    pub fn new(username: &str, perf: PerfType) -> Self {
        Self::get(format!("/api/user/{username}/perf/{perf}"), None, None)
    }
}