Skip to main content

RconClient

Struct RconClient 

Source
pub struct RconClient { /* private fields */ }
Expand description

Async RCON client for Factorio

Implementations§

Source§

impl RconClient

Source

pub async fn connect(addr: impl AsRef<str>, password: &str) -> Result<Self>

Connect to an RCON server and authenticate

Uses the default 5-second timeout for both TCP connection and auth.

§Arguments
  • addr - Server address (e.g., “127.0.0.1:27015”)
  • password - RCON password
§Example
use factorio_rcon::RconClient;

let mut client = RconClient::connect("127.0.0.1:27015", "password").await?;
Source

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

Execute an RCON command and return the response

§Arguments
  • command - Command to execute (e.g., “/version” or “/c game.tick”)
§Example
let version = client.execute("/version").await?;
println!("Server version: {}", version);
Source

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

Execute a command with a custom timeout

The timeout covers the entire round-trip (send + receive).

§Arguments
  • command - Command to execute
  • timeout_duration - Maximum time to wait for the complete operation
§Example
let result = client.execute_with_timeout(
    "/c rcon.print(serpent.line(game.surfaces))",
    Duration::from_secs(10)
).await?;
Source

pub fn set_timeout(&mut self, duration: Duration)

Configure the default timeout for operations

§Arguments
  • duration - New timeout duration

Trait Implementations§

Source§

impl Debug for RconClient

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more