Struct redis_async::client::pubsub::PubsubConnection

pub struct PubsubConnection { /* fields omitted */ }

A shareable reference to subscribe to PUBSUB topics

Methods

impl PubsubConnection

pub async fn subscribe<'_, '_>(
    &'_ self,
    topic: &'_ str
) -> Result<PubsubStream, Error>

Subscribes to a particular PUBSUB topic.

Returns a future that resolves to a Stream that contains all the messages published on that particular topic.

The resolved stream will end with redis_async::error::Error::EndOfStream if the underlying connection is lost for unexpected reasons. In this situation, clients should subscribe to re-subscribe; the underlying connect will automatically reconnect. However, clients should be aware that resubscriptions will only succeed if the underlying connection has re-established, so multiple calls to subscribe may be required.

pub fn unsubscribe<T: Into<String>>(&self, topic: T)

Tells the client to unsubscribe from a particular topic. This will return immediately, the actual unsubscription will be confirmed when the stream returned from subscribe ends.

Trait Implementations

impl Clone for PubsubConnection

fn clone(&self) -> PubsubConnection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PubsubConnection

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

Formats the value using the given formatter.