Struct ChannelManager 

pub struct ChannelManager { /* private fields */ }

Manager struct for a [RealtimeChannel]

Returned by RealtimeChannelBuilder::build()

Implementations

impl ChannelManager

pub fn subscribe(&self)

Send a JoinMessage for the channel

pub async fn unsubscribe( &self, ) -> Result<Result<ChannelState, ChannelSendError>, RecvError>

Leave the channel and stop recieving messages

Once unsubscribed this manager is useless and should be dropped

pub async fn subscribe_blocking(&self) -> Result<(), RecvError>

Send a JoinMessage for the channel and wait until the server has responded

pub fn broadcast(&self, payload: BroadcastPayload)

Send a broadcast message on the channel

pub async fn track( &self, payload: HashMap<String, Value>, ) -> Result<(), RecvError>

Track data in Presence

pub async fn untrack(&self) -> Result<(), RecvError>

Stop tracking with Presence

pub async fn get_state(&self) -> Result<ChannelState, RecvError>

Returns the ChannelState for the associated channel

pub async fn get_topic(&self) -> String

Returns the associated channel’s topic

pub async fn get_presence_state(&self) -> PresenceState

Returns the current PresenceState of the associated channel

pub fn to_sync(self) -> ChannelManagerSync

Return a sync wrapper ChannelManagerSync for this manager

Trait Implementations

impl Clone for ChannelManager

fn clone(&self) -> ChannelManager

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelManager

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

Formats the value using the given formatter.

impl<'a> FromIterator<&'a mut ChannelManager> for Vec<ChannelManager>

fn from_iter<T: IntoIterator<Item = &'a mut ChannelManager>>(iter: T) -> Self

Creates a value from an iterator.