pub struct ClientEventCallbacks<R>
where R: DeserializeOwned + Send + 'static,
{ /* private fields */ }
Expand description

Configuration for a client’s event callbacks.

§Events

There are two events for which callbacks can be registered:

  • receive
  • disconnect

Both callbacks are optional, and can be registered for any combination of these events. Note that each callback must be provided as a function or closure returning a thread-safe future. The future will be awaited by the runtime.

§Example


let client = Client::builder()
    .sending::<String>()
    .receiving::<usize>()
    .with_event_callbacks(
        ClientEventCallbacks::new()
            .on_receive(move |data| async move {
                // some async operation...
                println!("Received data from server: {}", data);
            })
            .on_disconnect(move || async move {
                // some async operation...
                println!("Disconnected from server");
            })
    )
    .connect(("127.0.0.1", 29275))
    .await
    .unwrap();

Implementations§

source§

impl<R> ClientEventCallbacks<R>
where R: DeserializeOwned + Send + 'static,

source

pub fn new() -> Self

Creates a new client event callbacks configuration with all callbacks empty.

source

pub fn on_receive<C, F>(self, callback: C) -> Self
where C: Fn(R) -> F + Send + 'static, F: Future<Output = ()> + Send + 'static,

Registers a callback on the receive event.

source

pub fn on_disconnect<C, F>(self, callback: C) -> Self
where C: Fn() -> F + Send + 'static, F: Future<Output = ()> + Send + 'static,

Registers a callback on the disconnect event.

Trait Implementations§

source§

impl<R> Default for ClientEventCallbacks<R>
where R: DeserializeOwned + Send + 'static,

source§

fn default() -> Self

Returns the “default value” for a type. 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, 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> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V