RealtimeChannelBuilder

Struct RealtimeChannelBuilder 

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

Builder struct for [RealtimeChannel]

Implementations§

Source§

impl RealtimeChannelBuilder

Source

pub fn new(topic: impl Into<String>) -> Self

Create a new channel builder

Source

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

Set the topic of the channel

Source

pub fn broadcast(self, broadcast_config: BroadcastConfig) -> Self

Set the broadcast config for this channel

Source

pub fn presence(self, presence_config: PresenceConfig) -> Self

Set the presence config for this channel

Source

pub fn on_postgres_change( self, event: PostgresChangesEvent, filter: PostgresChangeFilter, callback: impl FnMut(&PostgresChangesPayload) + 'static + Send, ) -> Self

Add a postgres changes callback to this channel

Source

pub fn on_presence( self, event: PresenceEvent, callback: impl Fn(String, PresenceState, PresenceState) + Send + 'static, ) -> Self

Add a presence callback to this channel

Source

pub fn on_broadcast( self, event: impl Into<String>, callback: impl FnMut(&HashMap<String, Value>) + 'static + Send, ) -> Self

Add a broadcast callback to this channel

Source

pub fn build_sync( self, client: &ClientManagerSync, ) -> Result<ChannelManagerSync, RecvError>

Consume self and return a new ChannelManagerSync that controls the newly created channel Automatically assigns the new channel in the client.

For async applications you may want self::build()

Source

pub async fn build( self, client: &ClientManager, ) -> Result<ChannelManager, RecvError>

Consume self and return a new ChannelManager that controls the newly created channel Automatically assigns the new channel in the client.

For sync applications you may want self::build_sync()

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

Source§

type Output = T

Should always be Self
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