Skip to main content

JavaStatus

Struct JavaStatus 

Source
pub struct JavaStatus {
    pub version: JavaVersion,
    pub players: JavaPlayers,
    pub description: String,
    pub favicon: Option<String>,
    pub map: Option<String>,
    pub gamemode: Option<String>,
    pub software: Option<String>,
    pub plugins: Option<SmallVec<[JavaPlugin; 8]>>,
    pub mods: Option<SmallVec<[JavaMod; 8]>>,
    pub raw_data: Value,
}
Expand description

Full status payload returned by a Java Edition server.

Produced by parsing the JSON body of the Status Response packet (0x00). Accessed via JavaServerStatus accessors or directly through ServerData::Java.

§Serde behaviour

favicon is excluded from serialisation (#[serde(skip_serializing)]) to avoid bloating JSON output — it is a base64 PNG that can be hundreds of KB. raw_data is excluded entirely (#[serde(skip)]).

Fields§

§version: JavaVersion

Server version information (name string + protocol number).

§players: JavaPlayers

Online / max player counts plus an optional sample list.

§description: String

Primary server description (MOTD). May contain §-color codes. Use JavaServerStatus::motd_clean to get a plain-text version.

§favicon: Option<String>

Base64-encoded 64×64 PNG favicon. None if the server does not send one. Excluded from JSON serialisation — use JavaServerStatus::favicon or save_favicon to access it.

§map: Option<String>

Current map/world name. Only present on servers that expose it (e.g. via a status plugin).

§gamemode: Option<String>

Game mode string (e.g. "Survival"). Plugin-specific, not standard.

§software: Option<String>

Server software name (e.g. "Paper 1.21.4"). Plugin-specific.

§plugins: Option<SmallVec<[JavaPlugin; 8]>>

Plugin list. SmallVec<[_; 8]> avoids a heap allocation for servers with 8 or fewer plugins, which covers most vanilla/lightly-modded setups. None when the server does not expose plugin information.

§mods: Option<SmallVec<[JavaMod; 8]>>

Mod list (Forge/Fabric servers). Same allocation strategy as plugins. None when the server does not expose mod information.

§raw_data: Value

Raw JSON response body. Excluded from serialisation. Useful for accessing non-standard fields added by server plugins.

Implementations§

Source§

impl JavaStatus

Source

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

Save the server favicon to a PNG file on disk.

Strips the optional data:image/png;base64, URI prefix before decoding.

§Errors
§Example
let client = McClient::builder().build();
if let Ok(s) = client.java("mc.hypixel.net").await {
    s.save_favicon("hypixel_icon.png")?;
}

Trait Implementations§

Source§

impl Clone for JavaStatus

Source§

fn clone(&self) -> JavaStatus

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for JavaStatus

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for JavaStatus

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for JavaStatus

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more