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

//! Fetching, exporting, streaming, and importing games.
//!
//! Games can be exported as [`GameJson`] (single game or user history) or as
//! raw PGN text, and requests for many games at once return a stream of
//! results rather than a single value, since the response can be very large.
//! [`stream_games_of_users`](LichessApi::stream_games_of_users) and
//! [`stream_games_by_ids`](LichessApi::stream_games_by_ids) instead stream
//! [`GameStream`] events for games as they start and finish, in real time.
//!
//! Most exports work without a token, but return more detail when
//! authenticated, and downloading your own games is rate limited more
//! generously than anonymous or third-party requests. Importing a game and
//! bookmarking a game both require an authenticated user.

use futures::stream::StreamExt;

use crate::client::LichessApi;
use crate::error::Result;
use crate::model::games::*;

impl LichessApi<reqwest::Client> {
    pub async fn export_one_game(
        &self,
        request: impl Into<export::one::GetRequest>,
    ) -> Result<GameJson> {
        self.get_single_model(request.into()).await
    }

    pub async fn export_ongoing_game(
        &self,
        request: impl Into<export::ongoing::GetRequest>,
    ) -> Result<GameJson> {
        self.get_single_model(request.into()).await
    }

    pub async fn export_games_of_user(
        &self,
        request: impl Into<export::by_user::GetRequest>,
    ) -> Result<impl StreamExt<Item = Result<GameJson>>> {
        self.get_streamed_models(request.into()).await
    }

    pub async fn export_games_by_ids(
        &self,
        request: impl Into<export::by_ids::PostRequest>,
    ) -> Result<impl StreamExt<Item = Result<GameJson>>> {
        self.get_streamed_models(request.into()).await
    }

    pub async fn stream_games_of_users(
        &self,
        request: impl Into<stream::by_users::PostRequest>,
    ) -> Result<impl StreamExt<Item = Result<GameStream>>> {
        self.get_streamed_models(request.into()).await
    }

    pub async fn stream_games_by_ids(
        &self,
        request: impl Into<stream::by_ids::PostRequest>,
    ) -> Result<impl StreamExt<Item = Result<GameStream>>> {
        self.get_streamed_models(request.into()).await
    }

    pub async fn add_game_ids_to_stream(
        &self,
        request: impl Into<stream::add_ids::PostRequest>,
    ) -> Result<bool> {
        self.get_ok(request.into()).await
    }

    pub async fn get_my_ongoing_games(
        &self,
        request: impl Into<ongoing::GetRequest>,
    ) -> Result<ongoing::Games> {
        self.get_single_model(request.into()).await
    }

    pub async fn stream_game_moves(
        &self,
        request: impl Into<stream::moves::GetRequest>,
    ) -> Result<impl StreamExt<Item = Result<stream::moves::Move>>> {
        self.get_streamed_models(request.into()).await
    }

    pub async fn import_game(
        &self,
        request: impl Into<import::PostRequest>,
    ) -> Result<import::ImportData> {
        self.get_single_model(request.into()).await
    }

    pub async fn export_bookmarked_games(
        &self,
        request: impl Into<export::bookmarks::GetRequest>,
    ) -> Result<impl StreamExt<Item = Result<GameJson>>> {
        self.get_streamed_models(request.into()).await
    }

    pub async fn export_imported_games(&self) -> Result<impl StreamExt<Item = Result<String>>> {
        self.get_pgn(export::imports::GetRequest::new()).await
    }

    pub async fn get_game_chat(
        &self,
        request: impl Into<chat::GetRequest>,
    ) -> Result<impl StreamExt<Item = Result<chat::ChatLine>>> {
        self.get_streamed_models(request.into()).await
    }

    pub async fn bookmark_game(&self, request: impl Into<bookmark::PostRequest>) -> Result<()> {
        self.get_empty(request.into()).await
    }
}