minecraft-pinger 0.1.5

A high-performance, asynchronous Rust library for pinging Minecraft servers to retrieve status, players, and metadata.
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188

use std::net::SocketAddr;
use crate::error::PingError;
use serde::{Deserialize, Serialize};

#[derive(Debug, Deserialize, Serialize, Default)]
#[serde(default)]
pub struct BedrockPing {
    pub edition: String,
    pub motd: String,
    pub protocol_version: u32,
    pub version: String,
    pub current_players: u32,
    pub max_players: u32,
    pub server_id: String,
    pub map_name: String,
    pub game_mode: String,
    pub numeric_id: Option<u8>,
    pub port: Option<u16>,
    pub unknown_val: Option<u32>,

    #[serde(skip_deserializing)]
    pub latency: u32,

    #[serde(skip_serializing, skip_deserializing)]
    pub connected_addr: Option<SocketAddr>,
}

impl TryFrom<String> for BedrockPing {
    type Error = PingError;

    fn try_from(data: String) -> Result<Self, Self::Error> {
        let parts: Vec<&str> = data.split(';').collect();
        if parts.len() < 8 {
            return Err(PingError::ParseResponse);
        }
        Ok(BedrockPing {
            edition: parts[0].to_string(),
            motd: parts[1].to_string(),
            protocol_version: parts[2].parse().unwrap_or(0),
            version: parts[3].to_string(),
            current_players: parts[4].parse().unwrap_or(0),
            max_players: parts[5].parse().unwrap_or(0),
            server_id: parts[6].to_string(),
            map_name: parts[7].to_string(),
            game_mode: parts.get(8).map(|s| s.to_string()).unwrap_or_default(),
            numeric_id: parts.get(9).and_then(|s| s.parse().ok()),
            port: parts.get(10).and_then(|s| s.parse().ok()),
            unknown_val: parts.get(11).and_then(|s| s.parse().ok()),
            latency: 0,
            connected_addr: None,
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_bedrock_ping_try_from_full() {
        let data = "MCPE;Test Server;589;1.20.0;10;20;1234567890;world;Survival;1;19132;123";
        let ping = BedrockPing::try_from(data.to_string()).unwrap();

        assert_eq!(ping.edition, "MCPE");
        assert_eq!(ping.motd, "Test Server");
        assert_eq!(ping.protocol_version, 589);
        assert_eq!(ping.version, "1.20.0");
        assert_eq!(ping.current_players, 10);
        assert_eq!(ping.max_players, 20);
        assert_eq!(ping.server_id, "1234567890");
        assert_eq!(ping.map_name, "world");
        assert_eq!(ping.game_mode, "Survival");
        assert_eq!(ping.numeric_id, Some(1));
        assert_eq!(ping.port, Some(19132));
        assert_eq!(ping.unknown_val, Some(123));
        assert_eq!(ping.latency, 0);
    }

    #[test]
    fn test_bedrock_ping_try_from_minimal() {
        let data = "MCPE;Test;589;1.20.0;0;20;1234567890;world;Creative";
        let ping = BedrockPing::try_from(data.to_string()).unwrap();

        assert_eq!(ping.edition, "MCPE");
        assert_eq!(ping.motd, "Test");
        assert_eq!(ping.protocol_version, 589);
        assert_eq!(ping.version, "1.20.0");
        assert_eq!(ping.current_players, 0);
        assert_eq!(ping.max_players, 20);
        assert_eq!(ping.game_mode, "Creative");
        assert_eq!(ping.numeric_id, None);
        assert_eq!(ping.port, None);
        assert_eq!(ping.unknown_val, None);
    }

    #[test]
    fn test_bedrock_ping_try_from_empty_game_mode() {
        let data = "MCPE;Test;589;1.20.0;0;20;1234567890;world";
        let ping = BedrockPing::try_from(data.to_string()).unwrap();

        assert_eq!(ping.game_mode, "");
    }

    #[test]
    fn test_bedrock_ping_try_from_invalid_protocol_version() {
        let data = "MCPE;Test;invalid;1.20.0;0;20;1234567890;world";
        let ping = BedrockPing::try_from(data.to_string()).unwrap();

        assert_eq!(ping.protocol_version, 0);
    }

    #[test]
    fn test_bedrock_ping_try_from_invalid_players() {
        let data = "MCPE;Test;589;1.20.0;invalid;invalid;1234567890;world";
        let ping = BedrockPing::try_from(data.to_string()).unwrap();

        assert_eq!(ping.current_players, 0);
        assert_eq!(ping.max_players, 0);
    }

    #[test]
    fn test_bedrock_ping_try_from_too_few_parts() {
        let data = "MCPE;Test;589;1.20.0;0;20;1234567890";
        let result = BedrockPing::try_from(data.to_string());

        assert!(result.is_err());
        match result.unwrap_err() {
            PingError::ParseResponse => {}
            _ => panic!("Expected ParseResponse error"),
        }
    }

    #[test]
    fn test_bedrock_ping_serialize_deserialize() {
        let ping = BedrockPing {
            edition: "MCPE".to_string(),
            motd: "Test".to_string(),
            protocol_version: 589,
            version: "1.20.0".to_string(),
            current_players: 10,
            max_players: 20,
            server_id: "1234567890".to_string(),
            map_name: "world".to_string(),
            game_mode: "Survival".to_string(),
            numeric_id: Some(1),
            port: Some(19132),
            unknown_val: Some(123),
            latency: 50,
            connected_addr: None,
        };

        let json = serde_json::to_string(&ping).unwrap();
        let deserialized: BedrockPing = serde_json::from_str(&json).unwrap();

        assert_eq!(deserialized.edition, ping.edition);
        assert_eq!(deserialized.motd, ping.motd);
        assert_eq!(deserialized.protocol_version, ping.protocol_version);
        assert_eq!(deserialized.version, ping.version);
        assert_eq!(deserialized.current_players, ping.current_players);
        assert_eq!(deserialized.max_players, ping.max_players);
        assert_eq!(deserialized.server_id, ping.server_id);
        assert_eq!(deserialized.map_name, ping.map_name);
        assert_eq!(deserialized.game_mode, ping.game_mode);
        assert_eq!(deserialized.numeric_id, ping.numeric_id);
        assert_eq!(deserialized.port, ping.port);
        assert_eq!(deserialized.unknown_val, ping.unknown_val);
        // latency is skipped in deserialization
        assert_eq!(deserialized.latency, 0);
    }

    #[test]
    fn test_bedrock_ping_default() {
        let ping = BedrockPing::default();
        assert_eq!(ping.edition, "");
        assert_eq!(ping.motd, "");
        assert_eq!(ping.protocol_version, 0);
        assert_eq!(ping.version, "");
        assert_eq!(ping.current_players, 0);
        assert_eq!(ping.max_players, 0);
        assert_eq!(ping.server_id, "");
        assert_eq!(ping.map_name, "");
        assert_eq!(ping.game_mode, "");
        assert_eq!(ping.numeric_id, None);
        assert_eq!(ping.port, None);
        assert_eq!(ping.unknown_val, None);
        assert_eq!(ping.latency, 0);
    }
}