Client

Struct Client 

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

High-level client with automatic message handling

This is a simplified wrapper around aerox_client::HighLevelClient that provides a cleaner API for common client operations.

§Example

use aerox::Client;

#[tokio::main]
async fn main() -> aerox::Result<()> {
    let mut client = Client::connect("127.0.0.1:8080").await?;

    // Register message handler
    client.on_message(1001, |id, msg: MyMessage| async move {
        println!("Received: {:?}", msg);
        Ok(())
    }).await?;

    // Send message
    client.send(1001, &my_message).await?;

    Ok(())
}

Implementations§

Source§

impl Client

Source

pub async fn connect(addr: impl Into<String>) -> Result<Self>

Connect to a server

§Arguments
  • addr - Server address (e.g., “127.0.0.1:8080”)
§Example
let client = Client::connect("127.0.0.1:8080").await?;
Source

pub async fn on_message<M, F>(&mut self, msg_id: u16, f: F) -> Result<()>
where M: Message + Default + Send + 'static, F: Fn(u16, M) -> Pin<Box<dyn Future<Output = ClientResult<()>> + Send>> + Send + Sync + 'static,

Register a message handler

§Arguments
  • msg_id - Message ID to handle
  • f - Async handler function
§Example
client.on_message(1001, |id, msg: MyMessage| async move {
    println!("Received message {}: {:?}", id, msg);
    Ok(())
}).await?;
Source

pub async fn send<M: Message>(&mut self, msg_id: u16, msg: &M) -> Result<()>

Send a message

§Arguments
  • msg_id - Message ID
  • msg - Message to send (must implement prost::Message)
§Example
client.send(1001, &my_message).await?;
Source

pub async fn is_connected(&self) -> bool

Check if connected to the server

§Example
if client.is_connected().await {
    println!("Still connected");
}
Source

pub fn inner(&self) -> &InnerClient

Get the inner client for advanced use cases

Source

pub fn inner_mut(&mut self) -> &mut InnerClient

Get a mutable reference to the inner client for advanced use cases

Source

pub fn into_inner(self) -> InnerClient

Consume and return the inner client

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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
Source§

impl<T> ConditionalSend for T
where T: Send,