Struct minecraft_server_query::tokio::QueryClient

pub struct QueryClient { /* private fields */ }

This is supported on crate feature tokio only.

An asynchronous Query client using the tokio networking primitives.

Implementations

impl QueryClient

pub async fn new(ip: &str) -> Result<Self>

Build a new QueryClient from the given IP address.

If not port is specified in the IP address, the default port is used.

The default timeout duration is used.

pub async fn new_with_port(ip: &str, port: u16) -> Result<Self>

Build a new QueryClient from the given IP address and port.

If the IP address already contains a port, an error is returned.

The default timeout duration is used.

pub async fn new_with_socket_address(
    ip: &str,
    port: u16,
    addr: impl ToSocketAddrs,
    timeout: Option<Duration>
) -> Result<Self>

Builds a new QueryClient from the given IP address, port, socket address and optional timeout.

The IP adress must not contain a port.

pub async fn recv(&self, buf: &mut [u8]) -> Result<usize>

Receive a UDP packet from the client socket.

pub async fn handshake(&self) -> Result<Token>

Send a UDP handshake packet to the client socket.

Receive and parse the response into a Query token, valid up to 30 seconds.

pub async fn basic_stat(&self, token: Token) -> Result<BasicStat>

Request and wait for a basic status packet on the client socket.

If the token is no longer valid, no packet is received and an error is returned.

pub async fn full_stat(&self, token: Token) -> Result<FullStat>

Request and wait for a full status packet on the client socket.

If the token is no longer valid, no packet is received and an error is returned.

Trait Implementations

impl Debug for QueryClient

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

Formats the value using the given formatter.