Struct PubSub

pub struct PubSub { /* private fields */ }

A connection dedicated to pubsub messages.

Implementations

impl PubSub

pub async fn new<C>( connection_info: &RedisConnectionInfo, stream: C, ) -> RedisResult<Self>

where C: Unpin + AsyncRead + AsyncWrite + Send + 'static,

Constructs a new MultiplexedConnection out of a AsyncRead + AsyncWrite object and a ConnectionInfo

pub async fn subscribe( &mut self, channel_name: impl ToRedisArgs, ) -> RedisResult<()>

Subscribes to a new channel(s).

let client = redis::Client::open("redis://127.0.0.1/")?;
let mut pubsub = client.get_async_pubsub().await?;
pubsub.subscribe("channel_1").await?;
pubsub.subscribe(&["channel_2", "channel_3"]).await?;

pub async fn unsubscribe( &mut self, channel_name: impl ToRedisArgs, ) -> RedisResult<()>

Unsubscribes from channel(s).

let client = redis::Client::open("redis://127.0.0.1/")?;
let mut pubsub = client.get_async_pubsub().await?;
pubsub.subscribe(&["channel_1", "channel_2"]).await?;
pubsub.unsubscribe(&["channel_1", "channel_2"]).await?;

pub async fn psubscribe( &mut self, channel_pattern: impl ToRedisArgs, ) -> RedisResult<()>

Subscribes to new channel(s) with pattern(s).

let client = redis::Client::open("redis://127.0.0.1/")?;
let mut pubsub = client.get_async_pubsub().await?;
pubsub.psubscribe("channel*_1").await?;
pubsub.psubscribe(&["channel*_2", "channel*_3"]).await?;

pub async fn punsubscribe( &mut self, channel_pattern: impl ToRedisArgs, ) -> RedisResult<()>

Unsubscribes from channel pattern(s).

let client = redis::Client::open("redis://127.0.0.1/")?;
let mut pubsub = client.get_async_pubsub().await?;
pubsub.psubscribe(&["channel_1", "channel_2"]).await?;
pubsub.punsubscribe(&["channel_1", "channel_2"]).await?;

pub async fn ping<T: FromRedisValue>(&mut self) -> RedisResult<T>

Sends a ping to the server

pub async fn ping_message<T: FromRedisValue>( &mut self, message: impl ToRedisArgs, ) -> RedisResult<T>

Sends a ping with a message to the server

pub fn on_message(&mut self) -> impl Stream<Item = Msg> + '_

Returns Stream of Msgs from this PubSubs subscriptions.

The message itself is still generic and can be converted into an appropriate type through the helper methods on it.

pub fn into_on_message(self) -> PubSubStream

Returns Stream of Msgs from this PubSubs subscriptions consuming it.

The message itself is still generic and can be converted into an appropriate type through the helper methods on it. This can be useful in cases where the stream needs to be returned or held by something other than the PubSub.

pub fn split(self) -> (PubSubSink, PubSubStream)

Splits the PubSub into separate sink and stream components, so that subscriptions could be updated through the Sink while concurrently waiting for new messages on the Stream.