litchee 0.1.5

Async, builder-pattern Rust client for the Lichess API: full endpoint coverage, NDJSON streaming, and OAuth2 PKCE ('Log in with Lichess').
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

//! The Messaging API: send private messages.
//!
//! Reached through [`LichessClient::messaging`].

use reqwest::Method;

use crate::client::LichessClient;
use crate::config::Host;
use crate::error::Result;
use crate::http;

/// Accessor for the Messaging API.
#[derive(Debug)]
pub struct MessagingApi<'a> {
    client: &'a LichessClient,
}

impl<'a> MessagingApi<'a> {
    /// Binds the accessor to a client.
    pub(crate) fn new(client: &'a LichessClient) -> Self {
        Self { client }
    }

    /// Sends a private message to another player.
    ///
    /// Requires the `msg:write` scope. `POST /inbox/{username}`
    pub async fn send(&self, username: &str, text: &str) -> Result<()> {
        let path = format!("/inbox/{}", http::segment(username));
        let request = self
            .client
            .request(Method::POST, Host::Default, &path)
            .form(&[("text", text)]);
        http::ok(request).await
    }
}

impl LichessClient {
    /// Messaging API: send private messages to other players.
    #[must_use]
    pub fn messaging(&self) -> MessagingApi<'_> {
        MessagingApi::new(self)
    }
}