Skip to main content

EventHandlers

Struct EventHandlers 

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

Connection lifecycle event handlers.

All handlers are optional. The builder pattern makes it easy to register only the handlers you need. Handlers are Send + Sync so they work with the async tokio runtime.

These handlers are invoked across all SDK platforms (Rust, TypeScript, Dart) with the same semantics.

Implementations§

Source§

impl EventHandlers

Source

pub fn new() -> EventHandlers

Create a new empty EventHandlers (no callbacks registered).

Source

pub fn on_connect(self, f: impl Fn() + Send + Sync + 'static) -> EventHandlers

Register a callback invoked when the shared connection becomes ready.

§Example
use kalam_client::EventHandlers;

let handlers = EventHandlers::new().on_connect(|| println!("Connected!"));
Source

pub fn on_disconnect( self, f: impl Fn(DisconnectReason) + Send + Sync + 'static, ) -> EventHandlers

Register a callback invoked when the WebSocket connection is closed.

The callback receives a DisconnectReason with details about why the connection was closed.

§Example
use kalam_client::EventHandlers;

let handlers =
    EventHandlers::new().on_disconnect(|reason| println!("Disconnected: {}", reason));
Source

pub fn on_error( self, f: impl Fn(ConnectionError) + Send + Sync + 'static, ) -> EventHandlers

Register a callback invoked when a connection error occurs.

The callback receives a ConnectionError indicating whether the error is recoverable (auto-reconnect may help) or fatal.

§Example
use kalam_client::EventHandlers;

let handlers = EventHandlers::new()
    .on_error(|err| eprintln!("Error (recoverable={}): {}", err.recoverable, err));
Source

pub fn on_receive( self, f: impl Fn(&str) + Send + Sync + 'static, ) -> EventHandlers

Register a callback invoked for every raw message received from the server.

This is a debug/tracing hook — it receives the raw JSON string of every inbound WebSocket message before parsing. Useful for logging or diagnostics. Not needed for normal operation.

§Example
use kalam_client::EventHandlers;

let handlers = EventHandlers::new().on_receive(|msg| println!("[RECV] {}", msg));
Source

pub fn on_send(self, f: impl Fn(&str) + Send + Sync + 'static) -> EventHandlers

Register a callback invoked for every raw message sent to the server.

This is a debug/tracing hook — it receives the raw JSON string of every outbound WebSocket message. Useful for logging or diagnostics.

§Example
use kalam_client::EventHandlers;

let handlers = EventHandlers::new().on_send(|msg| println!("[SEND] {}", msg));
Source

pub fn has_any(&self) -> bool

Returns true if any handler is registered.

Trait Implementations§

Source§

impl Clone for EventHandlers

Source§

fn clone(&self) -> EventHandlers

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for EventHandlers

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EventHandlers

Source§

fn default() -> EventHandlers

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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