Skip to main content

ChannelPresence

phoenix_channel_client

Struct ChannelPresence 

Source 
pub struct ChannelPresence<'a> { /* private fields */ }
Expand description

Current Presence state and changes for a joined channel.

The value borrows its Channel so a resynchronization can leave and rejoin the same channel with a freshly loaded join payload.

Implementations§

Source§

impl<'a> ChannelPresence<'a>

Source

pub fn state(&self) -> &PresenceState

Returns the current synchronized state.

Source

pub fn requires_resync(&self) -> bool

Returns whether event lag invalidated local state.

Source

pub async fn resync(&mut self) -> Result<(), ClientError>

Clears local state, leaves, and rejoins to request a fresh full state.

Source

pub async fn next( &mut self, ) -> Option<Result<PresenceEvent, PresenceStreamError>>

Returns the next Presence change or lifecycle event.

Auto Trait Implementations§

§

impl<'a> Freeze for ChannelPresence<'a>

§

impl<'a> !RefUnwindSafe for ChannelPresence<'a>

§

impl<'a> !Send for ChannelPresence<'a>

§

impl<'a> !Sync for ChannelPresence<'a>

§

impl<'a> Unpin for ChannelPresence<'a>

§

impl<'a> UnsafeUnpin for ChannelPresence<'a>

§

impl<'a> !UnwindSafe for ChannelPresence<'a>

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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, 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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more