Struct Channel 

pub struct Channel { /* private fields */ }

Handle for one Phoenix channel topic.

Dropping the handle unregisters the topic and its pending operations.

Implementations

impl Channel

pub fn topic(&self) -> &str

Returns the registered channel topic.

pub fn status(&self) -> ChannelStatus

Returns the latest channel status.

pub fn status_changes(&self) -> ChannelStatusChanges

Creates a stream of subsequent channel status changes.

pub async fn join(&self) -> Result<Payload, ClientError>

Joins using the default join timeout and a freshly loaded payload.

pub async fn join_with_timeout( &self, timeout: Duration, ) -> Result<Payload, ClientError>

Joins with an explicit timeout and a freshly loaded payload.

pub async fn call( &self, event: impl Into<String>, payload: impl Into<Payload>, ) -> Result<Reply, ClientError>

Sends an event and waits for its correlated reply.

pub async fn call_with_timeout( &self, event: impl Into<String>, payload: impl Into<Payload>, timeout: Duration, ) -> Result<Reply, ClientError>

Sends an event and waits up to timeout for its correlated reply.

pub async fn call_json<Request, Response>( &self, event: impl Into<String>, request: &Request, ) -> Result<Response, CallJsonError>

where Request: Serialize + ?Sized, Response: DeserializeOwned,

Serializes a JSON request, requires an ok reply, and decodes its response.

pub async fn cast( &self, event: impl Into<String>, payload: impl Into<Payload>, ) -> Result<(), ClientError>

Sends an event without asking Phoenix for a reply.

pub async fn cast_with_timeout( &self, event: impl Into<String>, payload: impl Into<Payload>, timeout: Duration, ) -> Result<(), ClientError>

Sends an event without asking Phoenix for a reply, waiting at most timeout for the frame to be accepted by the transport.

pub async fn leave(&self) -> Result<Payload, ClientError>

Leaves using the default leave timeout.

pub async fn leave_with_timeout( &self, timeout: Duration, ) -> Result<Payload, ClientError>

Leaves and waits up to timeout for the server reply.

pub async fn next_event(&mut self) -> Option<ChannelEvent>

Returns the next event from this handle’s original event stream.

pub fn events(&self) -> Result<ChannelEvents, ClientError>

Creates an independent bounded channel event subscriber.

pub fn subscribe( &self, event: impl Into<String>, ) -> Result<EventSubscription, ClientError>

Subscribes to application messages with one event name.

pub fn presence(&self) -> Result<ChannelPresence<'_>, ClientError>

Creates a synchronized Phoenix Presence consumer for this channel.

Trait Implementations

impl Drop for Channel

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.