mc-query 2.0.0

Implementations of Server List Ping, Query, and RCON for minecraft servers
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

//! All the errors defined by this crate.

use std::io::{self, ErrorKind};
use thiserror::Error;

/// An error from the Minecraft networking protocol.
#[derive(Error, Debug)]
pub enum MinecraftProtocolError {
    /// `VarInt` data was invalid according to the spec.
    #[error("invalid varint data")]
    InvalidVarInt,

    /// Received invalid state information from the server.
    #[error("invalid state")]
    InvalidState,

    /// Received incorrectly formatted status response from the server.
    #[error("invalid status response")]
    InvalidStatusResponse,
}

impl From<MinecraftProtocolError> for io::Error {
    fn from(err: MinecraftProtocolError) -> Self {
        io::Error::new(ErrorKind::InvalidData, err)
    }
}

/// An error from the RCON protocol.
#[derive(Error, Debug)]
pub enum RconProtocolError {
    /// Received non-ASCII payload data from the server.
    ///
    /// Note: some servers (for example Craftbukkit for Minecraft 1.4.7) reply
    /// with the section sign (0xa7) as a prefix for the payload. This error
    /// will not be returned in that case.
    #[error("non-ascii payload")]
    NonAsciiPayload,

    /// Authentication failed. You probably entered the wrong RCON password.
    #[error("authentication failed")]
    AuthFailed,

    /// Invalid or unexpected packet type received from the server.
    #[error("invalid packet type")]
    InvalidPacketType,

    /// Other kind of invalid response as defined by the spec.
    #[error("invalid rcon response")]
    InvalidRconResponse,

    /// Payload too long.
    ///
    /// | Direction   | Payload Length limit |
    /// | ----------- | -------------------- |
    /// | Serverbound | 1446                 |
    /// | Clientbound | 4096                 |
    #[error("payload too long")]
    PayloadTooLong,

    /// Mismatch with the given request ID.
    ///
    /// Note: the server replies with a request ID of -1 in the case of an
    /// authentication failure. In that case, `AuthFailed` will be returned.
    /// This variant is returned if any *other* request ID was received.
    #[error("request id mismatch")]
    RequestIdMismatch,
}

impl From<RconProtocolError> for io::Error {
    fn from(err: RconProtocolError) -> Self {
        io::Error::new(ErrorKind::InvalidData, err)
    }
}

/// An error from the Query protocol.
#[derive(Error, Debug)]
pub enum QueryProtocolError {
    /// Received invalid packet type.
    /// Valid types are 9 for handshake, 0 for stat
    #[error("invalid packet type")]
    InvalidPacketType,

    /// Unexpected packet type.
    #[error("unexpected packet type")]
    UnexpectedPacketType,

    /// Mismatch with the generated session ID.
    #[error("session id mismatch")]
    SessionIdMismatch,

    /// Received invalid challenge token from server.
    #[error("invalid challenge token")]
    InvalidChallengeToken,

    /// Invalid integer.
    /// Did not receive valid characters to parse as an integer in the string
    #[error("cannot parse int")]
    CannotParseInt,

    /// Invalid UTF8.
    /// Did not receive valid UTF from the server when a string was expected
    #[error("invalid UTF-8")]
    InvalidUtf8,

    /// Invalid key/value section.
    /// Expecting something like [this](https://wiki.vg/Query#K.2C_V_section)
    #[error("invalid key/value section")]
    InvalidKeyValueSection,
}

impl From<QueryProtocolError> for io::Error {
    fn from(err: QueryProtocolError) -> Self {
        io::Error::new(ErrorKind::InvalidData, err)
    }
}

pub(crate) fn timeout_err<T>() -> io::Result<T> {
    Err(io::Error::new(ErrorKind::TimedOut, "connection timed out"))
}