Struct mc_query::rcon::RconClient

pub struct RconClient { /* private fields */ }

Struct that stores the connection and other state of the RCON protocol with the server.

Examples

use mc_query::rcon::RconClient;
use tokio::io::Result;

#[tokio::main]
async fn main() -> Result<()> {
    let mut client = RconClient::new("localhost", 25575).await?;
    client.authenticate("password").await?;

    let output = client.run_command("time set day").await?;
    println!("{output}");

    Ok(())
}

Implementations

impl RconClient

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

Construct an RconClient that connects to the given host and port. Note: to authenticate use the authenticate method, this method does not take a password.

Arguments

• host - A string slice that holds the hostname of the server to connect to.
• port - The port to connect to.

Errors

Returns Err if there was a network error.

pub async fn disconnect(self) -> Result<()>

Disconnect from the server and close the RCON connection.

Errors

Returns Err if there was an issue closing the connection.

pub async fn authenticate(&mut self, password: &str) -> Result<()>

Authenticate with the server, with the given password.

If authentication fails, this method will return RconProtocolError::AuthFailed.

Arguments

• password - A string slice that holds the RCON password.

Errors

Returns the raw tokio::io::Error if there was a network error. Returns an apprpriate RconProtocolError if the authentication failed for other reasons.

pub async fn run_command(&mut self, command: &str) -> Result<String>

Run the given command on the server and return the result.

Arguments

• command - A string slice that holds the command to run. Must be ASCII and under 1446 bytes in length.

Errors

Returns an error if there was a network issue or an RconProtocolError for other failures.

Trait Implementations

impl Debug for RconClient

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

Formats the value using the given formatter.