pub struct RconClient { /* private fields */ }Expand description
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§
Source§impl RconClient
impl RconClient
Sourcepub async fn new(host: &str, port: u16) -> Result<Self>
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.
Clients constructed this way will wait arbitrarily long (maybe forever!) to recieve
a response from the server. To set a timeout, see [with_timeout] or [set_timeout].
§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.
Sourcepub async fn with_timeout(
host: &str,
port: u16,
timeout: Duration,
) -> Result<Self>
pub async fn with_timeout( host: &str, port: u16, timeout: Duration, ) -> Result<Self>
Construct an RconClient that connects to the given host and port, and a connection
timeout.
Note: to authenticate use the authenticate method, this method does not take a password.
Note that timeouts are not precise, and may vary on the order of milliseconds, because of the way the async event loop works.
§Arguments
host- A string slice that holds the hostname of the server to connect to.port- The port to connect to.timeout- A duration to wait for each response to arrive in.
§Errors
Returns Err if there was a network error.
Sourcepub fn set_timeout(&mut self, timeout: Option<Duration>)
pub fn set_timeout(&mut self, timeout: Option<Duration>)
Change the timeout for future requests.
§Arguments
timeout- an option specifying the duration to wait for a response. if none, the client may wait forever.
Sourcepub async fn disconnect(self) -> Result<()>
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.
Sourcepub async fn authenticate(&mut self, password: &str) -> Result<()>
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.
Also returns an error if a timeout is set, and the response is not recieved in that timeframe.
Sourcepub async fn run_command(&mut self, command: &str) -> Result<String>
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.
Also returns an error if a timeout was set and a response was not recieved in that timeframe.