Enum mcquery::Query

pub enum Query {
    Basic(BasicQueryResponse),
    Full(FullQueryResponse),
}

The main data structure in this crate

Description

Basic queries are enabled by default. They can be diabled in the server's server.properties with enable-status=true. This is what is used in the server list inside Minecraft.

Full queries are diabled by default. They can be enabled in the server's server.properties with enable-query=true.

Variants

Basic(BasicQueryResponse)

Response to a basic query. Can be obtained with Query::get_basic()

See BasicQueryResponse for more

Full(FullQueryResponse)

Response to a full query. Can be obtained with Query::get_full()

See FullQueryResponse for more

Implementations

impl Query

pub async fn get_basic<A: ToSocketAddrs, '_>(
    address: A,
    timeout: Duration,
    buffer: &'_ mut [u8]
) -> Result<Self>

Connects with the Minecraft server at address and performs a basic query. timeout is used as a response timeout. The specified buffer needs to be big enough to hold all response bytes, else this function will return a MaybeIncompleteDataError wrapped in an std::io::Error. The Ok value will be Query::Basic.

pub async fn get_full<A: ToSocketAddrs, '_>(
    address: A,
    timeout: Duration,
    buffer: &'_ mut [u8]
) -> Result<Self>

Connects with the Minecraft server at address and performs a full query. timeout is used as a response timeout. The specified buffer needs to be big enough to hold all response bytes, else this function will return a MaybeIncompleteDataError wrapped in an std::io::Error. The Ok vlaue will be Query::Full.

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Query

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

Formats the value using the given formatter.

impl Eq for Query

impl PartialEq<Query> for Query

fn eq(&self, other: &Query) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Query) -> bool

This method tests for !=.

impl StructuralEq for Query

impl StructuralPartialEq for Query