Struct JavaServerStatus 

pub struct JavaServerStatus(/* private fields */);

Typed wrapper around a Java Edition ServerStatus.

Implements StatusExt for common fields and serde::Serialize via #[serde(transparent)] — serialises identically to the inner ServerStatus.

Accessing raw fields

Use .raw() to get the underlying ServerStatus directly, or match on ServerData::Java for the raw JavaStatus.

Example

use rust_mc_status::{McClient, StatusExt};

let client = McClient::builder().build();
let s = client.java("mc.hypixel.net").await?;

println!("Version  : {}", s.version());
println!("Players  : {}", s.display_players());
println!("Latency  : {:.0} ms", s.latency_ms());
println!("MOTD     : {}", s.motd_clean());
println!("Cached   : {}", s.is_cached());

Implementations

impl JavaServerStatus

pub fn motd(&self) -> &str

Primary MOTD / description as returned by the server.

May contain §-color codes. Use motd_clean to strip them. Returns "" when the inner data is not Java (shouldn’t happen in normal usage).

pub fn motd_clean(&self) -> String

Primary MOTD with all Minecraft §-formatting codes removed and whitespace normalised.

Equivalent to strip_formatting applied to motd.

pub fn version(&self) -> &str

Server version name, e.g. "1.21.4" or "Requires MC 1.8 / 1.21".

pub fn players_online(&self) -> i64

Number of players currently online as reported by the server.

Large networks often report custom inflated numbers here.

pub fn players_max(&self) -> i64

Maximum player capacity as reported by the server.

pub fn favicon(&self) -> Option<&str>

Base64-encoded 64×64 PNG favicon, if the server provides one.

The string may include a data:image/png;base64, prefix. Use save_favicon to decode and write to disk.

pub fn save_favicon(&self, filename: &str) -> Result<(), McError>

Decode the favicon and write it to filename as a PNG file.

Errors

• [McError::Protocol] — no favicon available.
• [McError::Protocol] — base64 decoding failed.
• [McError::Io] — file could not be created or written.

pub fn is_cached(&self) -> bool

true if this result was served from the response cache.

Cached responses have latency_ms() == 0.0 and reflect the server state at the time of the original ping, not the current moment. The maximum age is determined by the TTL passed to McClientBuilder::response_cache.

pub fn raw(&self) -> &ServerStatus

Access the underlying ServerStatus directly.

Use this to access fields not surfaced by the typed accessors, such as dns, meta, or to match on ServerData for the full JavaStatus.

Trait Implementations

impl Debug for JavaServerStatus

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

Formats the value using the given formatter.

impl Display for JavaServerStatus

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

Formats the value using the given formatter.

impl Serialize for JavaServerStatus

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StatusExt for JavaServerStatus

fn latency_ms(&self) -> f64

Round-trip latency in milliseconds.

fn ip(&self) -> &str

Resolved IP address of the server, e.g. "172.65.197.160".

fn hostname(&self) -> &str

Original hostname as provided to the ping call, e.g. "mc.hypixel.net".

fn port(&self) -> u16

Port that was connected to, e.g. 25565.

fn is_online(&self) -> bool

true if the server responded successfully within the timeout.

fn display_players(&self) -> String

Formatted "online/max" player string, e.g. "21000/200000".