Struct ChannelBuilder 

pub struct ChannelBuilder { /* private fields */ }

Builder struct for RealtimeChannel

Get access to this through [RealtimeClient::channel()]

Implementations

impl ChannelBuilder

pub fn topic(&mut self, topic: impl Into<String>) -> &mut Self

Set the topic of the channel

pub fn set_broadcast_config( &mut self, broadcast_config: BroadcastConfig, ) -> &mut Self

Set the broadcast config for this channel

pub fn set_presence_config( &mut self, presence_config: PresenceConfig, ) -> &mut Self

Set the presence config for this channel

pub fn on_postgres_change( &mut self, event: PostgresChangesEvent, filter: PostgresChangeFilter, callback: SystemId<In<PostgresChangesPayload>>, ) -> &mut Self

Add a postgres changes callback to this channel

pub fn on_presence( &mut self, event: PresenceEvent, callback: SystemId<In<(String, PresenceState, PresenceState)>>, ) -> &mut Self

Add a presence callback to this channel

pub fn on_broadcast( &mut self, event: impl Into<String>, callback: SystemId<In<HashMap<String, Value>>>, ) -> &mut Self

Add a broadcast callback to this channel

pub fn build( &self, client: &ClientManager, presence_state_callback_event_sender: CrossbeamEventSender<PresenceStateCallbackEvent>, channel_state_callback_event_sender: CrossbeamEventSender<ChannelStateCallbackEvent>, broadcast_callback_event_sender: CrossbeamEventSender<BroadcastCallbackEvent>, presence_callback_event_sender: CrossbeamEventSender<PresenceCallbackEvent>, postgres_changes_callback_event_sender: CrossbeamEventSender<PostgresChangesCallbackEvent>, ) -> ChannelManager

Create the channel and pass ownership to provided [RealtimeClient], returning the channel id for later access through the client

Trait Implementations

impl Clone for ChannelBuilder

fn clone(&self) -> ChannelBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for ChannelBuilder

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

fn register_required_components( _component_id: ComponentId, _components: &mut Components, _storages: &mut Storages, _required_components: &mut RequiredComponents, _inheritance_depth: u16, )

Registers required components.

impl Event for ChannelBuilder

where Self: Send + Sync + 'static,

const AUTO_PROPAGATE: bool = false

When true, this event will always attempt to propagate when triggered, without requiring a call to Trigger::propagate.

type Traversal = ()

The component that describes which Entity to propagate this event to next, when propagation is enabled.