Struct NativeChannel 

pub struct NativeChannel { /* private fields */ }

Send + Sync handle for one Phoenix channel topic.

Implementations

impl NativeChannel

pub fn topic(&self) -> &str

Returns the registered topic.

pub fn status(&self) -> ChannelStatus

Returns the latest channel status.

pub fn events(&self) -> NativeChannelEvents

Creates an independent bounded channel event receiver.

pub fn status_changes(&self) -> NativeChannelStatusChanges

Creates a receiver for subsequent channel status changes.

pub fn presence(&self) -> NativeChannelPresence

Creates a synchronized Presence consumer for this channel.

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

Subscribes to application messages with one event name.

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

Joins with the configured default timeout.

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

Joins with an explicit timeout.

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

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, NativeRuntimeError>

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

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

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

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

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

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<(), NativeRuntimeError>

Sends a cast, waiting at most timeout for transport acceptance.

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

Leaves with the configured default timeout.

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

Leaves and waits up to timeout for the server reply.

Trait Implementations

impl Clone for NativeChannel

fn clone(&self) -> NativeChannel

Returns a duplicate of the value.

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

Performs copy-assignment from source.