Struct ServerPingBuilder 

pub struct ServerPingBuilder { /* private fields */ }

Builder for a ping request where the edition is chosen at runtime.

Constructed by McClient::server. Useful when edition comes from user input or config files.

Example

use rust_mc_status::{McClient, ServerEdition};
use std::time::Duration;

let client = McClient::builder().build();
let edition: ServerEdition = "java".parse()?;

let is_online = client
    .server("mc.hypixel.net", edition)
    .timeout(Duration::from_secs(3))
    .is_online()
    .await;

println!("Online: {}", is_online);

Implementations

impl ServerPingBuilder

pub fn timeout(self, duration: Duration) -> Self

Override the timeout for this request only.

pub async fn is_online(self) -> bool

Returns true if the server responds within the timeout, without allocating a full status object.

Trait Implementations

impl IntoFuture for ServerPingBuilder

type Output = Result<ServerStatus, McError>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <ServerPingBuilder as IntoFuture>::Output> + Send>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.