Skip to main content

Hooks

Trait Hooks 

Source
pub trait Hooks: Send + Sync {
    // Provided methods
    fn create_room(&self, _room: &Room, _state: &Value) { ... }
    fn create_presence(&self, _room: &Room, _presence: &Presence) { ... }
    fn remove_presence(&self, _room: &Room, _presence: &Presence) { ... }
    fn on_connection(&self, _room: &Room, _state: &Value) { ... }
    fn on_event(&self, _room: &Room, _packet: &Value) -> bool { ... }
    fn on_binary(&self, _room: &Room, _data: &[u8]) { ... }
    fn on_presence(&self, _room: &Room) { ... }
    fn on_closed(&self, _room: &Room, _reason: Option<&str>) { ... }
}
Expand description

Room lifecycle hooks. Every method defaults to a no-op, like the optional members of the TypeScript Hooks object. Rust can’t return a Room subclass from create_room, so wrappers capture the base room there instead.

Provided Methods§

Source

fn create_room(&self, _room: &Room, _state: &Value)

Source

fn create_presence(&self, _room: &Room, _presence: &Presence)

Source

fn remove_presence(&self, _room: &Room, _presence: &Presence)

Source

fn on_connection(&self, _room: &Room, _state: &Value)

Source

fn on_event(&self, _room: &Room, _packet: &Value) -> bool

Source

fn on_binary(&self, _room: &Room, _data: &[u8])

A binary frame, once the room has connected.

Source

fn on_presence(&self, _room: &Room)

Fired after the presence list changes (join / leave / update).

Source

fn on_closed(&self, _room: &Room, _reason: Option<&str>)

The room ended for good: the server closed it (host left, empty reap, or TTL) or no longer lets you in. A socket that drops reconnects on its own and never ends the room.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types§

Source§

impl Hooks for ()

Implementors§