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

pub mod account;
pub mod analysis;
pub mod arena_tournaments;
pub mod board;
pub mod bot;
pub mod broadcasts;
pub mod bulk_pairings;
pub mod challenges;
pub mod external_engine;
pub mod fide;
pub mod games;
pub mod messaging;
#[cfg(feature = "oauth")]
pub mod oauth;
pub mod openings;
pub mod puzzles;
pub mod relations;
pub mod simuls;
pub mod studies;
pub mod swiss_tournaments;
pub mod tablebase;
pub mod teams;
pub mod tv;
pub mod users;

use futures::stream::StreamExt;

use crate::client::LichessApi;
use crate::error::{Error, Result};
use crate::model::{BodyBounds, ModelBounds, QueryBounds, Request, Response};

impl LichessApi<reqwest::Client> {
    pub async fn get_ok<Q, B>(&self, request: Request<Q, B>) -> Result<bool>
    where
        Q: QueryBounds,
        B: BodyBounds,
    {
        let result = self
            .get_single_model::<Q, B, crate::model::Ok>(request)
            .await;
        Ok(result?.ok)
    }

    pub async fn get_pgn<Q, B>(
        &self,
        request: Request<Q, B>,
    ) -> Result<impl StreamExt<Item = Result<String>>>
    where
        Q: QueryBounds,
        B: BodyBounds,
    {
        let request = request.into_http_request("application/x-chess-pgn")?;
        let stream = self.make_request_as_raw_lines(request).await?;
        Ok(stream)
    }

    pub async fn get_text<Q, B>(&self, request: Request<Q, B>) -> Result<String>
    where
        Q: QueryBounds,
        B: BodyBounds,
    {
        let request = request.into_http_request("text/plain")?;
        let mut stream = self.make_request_as_raw_lines(request).await?;
        let mut lines = Vec::new();
        while let Some(line) = stream.next().await {
            lines.push(line?);
        }
        Ok(lines.join("\n"))
    }

    pub async fn get_empty<Q, B>(&self, request: Request<Q, B>) -> Result<()>
    where
        Q: QueryBounds,
        B: BodyBounds,
    {
        let request = request.into_http_request("application/json")?;
        let mut stream = self.make_request(request).await?;
        self.expect_empty(&mut stream).await?;
        Ok(())
    }

    pub async fn get_single_model<Q, B, M>(&self, request: Request<Q, B>) -> Result<M>
    where
        Q: QueryBounds,
        B: BodyBounds,
        M: ModelBounds,
    {
        let request = request.into_http_request("application/json")?;
        let mut stream = self.make_request(request).await?;
        let res: Response<M> = self.expect_one_model(&mut stream).await?;
        match res {
            Response::Model(m) => Ok(m),
            Response::Error { error } => Err(Error::LichessStatus(error)),
        }
    }

    pub async fn get_streamed_models<Q, B, M>(
        &self,
        request: Request<Q, B>,
    ) -> Result<impl StreamExt<Item = Result<M>>>
    where
        Q: QueryBounds,
        B: BodyBounds,
        M: ModelBounds,
    {
        let request = request.into_http_request("application/x-ndjson")?;
        self.make_request(request).await
    }
}