Struct PingResult 

pub struct PingResult {
    pub data: ServerData,
    pub latency: f64,
    pub meta: HashMap<String, String>,
}

Raw result returned by a PingProtocol before it is assembled into a ServerStatus.

Separating latency from data keeps the trait signature clean — protocol implementations don’t need to embed timing inside their own models.

meta is a forward-compatibility escape hatch: protocol-specific fields that don’t yet have a typed ServerData variant go here as key-value strings. Once a field is stable enough to model properly, it graduates into the appropriate ServerData variant and is removed from meta.

Implementing a new protocol

use rust_mc_status::{PingResult, models::ServerData};
use rust_mc_status::protocol::{PingProtocol, ResolvedTarget};
use rust_mc_status::core::time::{start_timer, elapsed_ms};
use rust_mc_status::McError;
use std::time::Duration;

#[derive(Debug, Clone, Copy, Default)]
pub struct QueryProtocol;

impl PingProtocol for QueryProtocol {
    fn name(&self) -> &'static str { "query" }

    async fn ping(
        &self,
        target: &ResolvedTarget,
        timeout: Duration,
        proxy: Option<&rust_mc_status::ProxyConfig>,
    ) -> Result<PingResult, McError> {
        let start = start_timer();
        // … UDP handshake, stat request, parse response …
        Ok(PingResult::new(
            ServerData::Query(Default::default()),
            elapsed_ms(start),
        ))
    }
}

Fields

data: ServerData

Edition-specific server data — Java, Bedrock, Legacy, or Query.

latency: f64

Round-trip latency in milliseconds. Always ≥ 0 (measured with a monotonic clock via core::time::elapsed_ms).

meta: HashMap<String, String>

Protocol-specific extra fields not yet modelled in ServerData.

Keys should be short lowercase strings, e.g. "forge_version" or "netty_channel_id". Forwarded verbatim into ServerStatus::meta.

Implementations

impl PingResult

pub fn new(data: ServerData, latency: f64) -> Self

Create a PingResult with an empty meta map.

Use this for all current protocols — Java Modern and Bedrock expose everything through typed ServerData variants.

pub fn with_meta( data: ServerData, latency: f64, meta: impl Into<HashMap<String, String>>, ) -> Self

Create a PingResult with protocol-specific metadata.

Use this when a new protocol exposes fields that don’t yet have a typed ServerData variant.

Trait Implementations

impl Clone for PingResult

fn clone(&self) -> PingResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PingResult

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

Formats the value using the given formatter.