Struct craftping::Response

#[non_exhaustive]
pub struct Response {
    pub version: String,
    pub protocol: i32,
    pub enforces_secure_chat: Option<bool>,
    pub previews_chat: Option<bool>,
    pub max_players: usize,
    pub online_players: usize,
    pub sample: Option<Vec<Player>>,
    pub description: Chat,
    pub favicon: Option<Vec<u8>>,
    pub mod_info: Option<ModInfo>,
    pub forge_data: Option<ForgeData>,
    /* private fields */
}

A ping response returned from server. The response schema can be altered anytime, thus #[non_exhaustive].

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

version: String

The version name of the server.

protocol: i32

The protocol number of the server. See also the minecraft protocol wiki for the actual values.

enforces_secure_chat: Option<bool>

If the server requires the user to sign chat messages with their private key.

previews_chat: Option<bool>

max_players: usize

The maximum number of the connected players.

online_players: usize

The number of the players currently connected.

sample: Option<Vec<Player>>

The sample of the connected players. Note that it can be None even if some players are connected.

description: Chat

The description (aka MOTD) of the server. See also the minecraft protocol wiki for the Chat format.

favicon: Option<Vec<u8>>

The favicon of the server in PNG format.

mod_info: Option<ModInfo>

The mod information object used in FML protocol (version 1.7 - 1.12). See also the minecraft protocol wiki for the ModInfo format.

forge_data: Option<ForgeData>

The forge information object used in FML2 protocol (version 1.13 - current). See also the minecraft protocol wiki for the ForgeData format.

Implementations

impl Response

pub fn raw(&self) -> &[u8]

The raw response returned from the server. It is Vec<u8> because server is not guaranteed to return valid UTF-8, even not a json at all.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Response

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Response

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Response

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.