Struct rcon::Connection

pub struct Connection<T> { /* fields omitted */ }

Implementations

impl Connection<AsyncStdStream>

pub async fn connect<A: ToSocketAddrs>(
    address: A,
    password: &str
) -> Result<Self>

This is supported on crate feature rt-async-std only.

Connect to an rcon server using the async-std runtime.

By default this enables Minecraft quirks. If you need to customize this behaviour, use a Builder.

impl Connection<TcpStream>

pub async fn connect<A: ToSocketAddrs>(
    address: A,
    password: &str
) -> Result<Self>

This is supported on crate feature rt-tokio only.

Connect to an rcon server using the Tokio runtime.

By default this enables Minecraft quirks. If you need to customize this behaviour, use a Builder.

impl<T: AsyncRead + AsyncWrite + Unpin> Connection<T>

pub fn builder() -> Builder<T>

Create a connectiion builder. Allows configuring the rcon connection.

pub async fn handshake(io: T, password: &str) -> Result<Self>

This is supported on crate features rt-tokio or rt-async-std only.

Perform a handshake on an existing connection to an rcon server.

This is a lower-level method mostly useful when integrating this crate with another runtime, or running rcon over a transport other than TCP. You generally will want to use one of the higher-level connect methods.

By default this enables Minecraft quirks. If you need to customize this behaviour, use a Builder.

This method requires one of the runtime features to be activated so that Minecraft quirks mode is able to asynchronously sleep. If you want to provide a custom sleep function, see Builder::sleep_fn.

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