mc-ping 0.0.20

Simple Java Minecraft Server Pinger
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

use serde::Deserialize;

/// Structure for the Minecraft server status response.
///
/// Corresponds to the JSON response returned by the server status query.
#[derive(Debug, Deserialize)]
pub struct ServerStatus {
    /// Server version information.
    pub version: Version,

    /// Server description, usually the MOTD (Message Of The Day).
    pub description: Description,

    /// Player information: maximum allowed and currently online.
    pub players: Players,

    /// List of server mods, if any (may be absent).
    /// If no mods are present, this will be an empty array.
    #[serde(default)]
    pub mods: Vec<Mod>,

    /// Other additional fields that might be present, e.g. favicon.
    /// If absent in the response, will be None.
    #[serde(default)]
    pub favicon: Option<String>,

    /// Additional properties for future extensions.
    #[serde(flatten)]
    pub extra: serde_json::Value,
}

/// Server version.
#[derive(Debug, Deserialize)]
pub struct Version {
    /// Version name, e.g. "Purpur 1.21"
    pub name: String,

    /// Protocol version number, e.g. 767.
    pub protocol: i32,
}

/// Server description — usually the MOTD.
///
/// Can be either a string or a more complex JSON object,
/// so it's best represented by the `Description` type.
#[derive(Debug, Deserialize)]
#[serde(untagged)]
pub enum Description {
    /// Simple text description.
    Text(String),

    /// Complex description (text components with colors and formatting).
    Complex(serde_json::Value),
}

/// Player information.
#[derive(Debug, Deserialize)]
pub struct Players {
    /// Maximum number of players allowed on the server.
    pub max: i32,

    /// Current number of online players.
    pub online: i32,

    /// List of sample players, if present (usually empty or missing).
    #[serde(default)]
    pub sample: Vec<Player>,
}

/// Player entry, if a player list is available.
#[derive(Debug, Deserialize)]
pub struct Player {
    /// Player's name.
    pub name: String,

    /// Player's UUID.
    pub id: String,
}

/// Server mod, if a mod list is present.
#[derive(Debug, Deserialize)]
pub struct Mod {
    /// Mod identifier.
    pub id: String,

    /// Mod name.
    pub name: String,
}