Struct RedisSub

pub struct RedisSub { /* private fields */ }

Redis subscription object. This connects to the Redis server.

Implementations

impl RedisSub

pub fn new(addr: &str) -> Self

Create the new Redis client. This does not connect to the server, use .listen() for that.

pub async fn subscribe(&self, channel: String) -> Result<()>

Subscribe to a channel.

Errors

Returns an error if an error happens on the underlying TCP stream.

pub async fn unsubscribe(&self, channel: String) -> Result<()>

Unsubscribe from a channel.

Errors

Returns an error if an error happens on the underlying TCP stream.

pub async fn psubscribe(&self, channel: String) -> Result<()>

Subscribe to a pattern of channels.

Errors

Returns an error if an error happens on the underlying TCP stream.

pub async fn punsubscribe(&self, channel: String) -> Result<()>

Unsubscribe from a pattern of channels.

Errors

Returns an error if an error happens on the underlying TCP stream.

pub async fn listen(&self) -> Result<impl Stream<Item = Message> + '_>

Listen for incoming messages. Only here the server connects to the Redis server. It handles reconnection and backoff for you.

Errors

Returns an error if the first connection attempt fails

Trait Implementations

impl Debug for RedisSub

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

Formats the value using the given formatter.