serverseeker 0.3.11

Rust wrapper for DAMcrafts Minecraft ServerSeeker 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

use crate::ServerSeekerClient;
use derive_builder::Builder;
use serde::{Deserialize, Serialize, Serializer};
use std::ops::{Range, RangeFrom};
use reqwest::Method;

/// The server ip/port
#[derive(Serialize, Builder, Default)]
#[builder(name = "ServerInfoBuilder", public, setter(strip_option), default)]
pub struct ServerInfoParams {
    /// The IP of the server
    #[builder(setter(into))]
    pub ip: String,

    /// The port of the server (default=25565)
    pub port: Option<u16>,
}

/// The information about the server
#[derive(Serialize, Deserialize, Debug)]
pub struct ServerInfoInfo {
    /// Whether the server is cracked or not. None if unknown
    pub cracked: Option<bool>,

    /// The description (MOTD) of the server
    pub description: String,

    /// The last time the server was seen (unix timestamp)
    pub last_seen: i64,

    /// The maximum amount of players the server can hold
    pub max_players: u32,

    /// The amount of players online during the last scan
    pub online_players: u16,

    /// The [protocol version](https://wiki.vg/Protocol_version_numbers) of the server
    pub protocol: i64,

    /// The minecraft version of the server
    pub version: String,

    /// An array of when which players were seen on the server. Limited to 1000
    pub players: Vec<ServerInfoPlayer>,
}

/// A player that was seen on a server
#[derive(Serialize, Deserialize, Debug)]
pub struct ServerInfoPlayer {
    /// The last time the player was seen on the server (unix timestamp)
    pub last_seen: i64,

    /// The name of the player
    pub name: String,

    /// The uuid of the player
    pub uuid: String,
}

impl ServerSeekerClient {
    /// Get information about a server
    pub async fn server_info(
        &self,
        builder: &ServerInfoBuilder,
    ) -> anyhow::Result<ServerInfoInfo> {
        let mut params = builder.build()?;
        Ok(self
            .request::<ServerInfoInfo, _, _>("/server_info", params, Method::POST)
            .await?)
    }
}