Struct Subscriber 

pub struct Subscriber { /* private fields */ }

Redis Pub/Sub subscriber

Implementations

impl Subscriber

pub fn new(connection: Arc<Mutex<dyn PubSubConnection + Send + Sync>>) -> Self

Create a new subscriber

pub async fn subscribe(&mut self, channels: Vec<String>) -> RedisResult<()>

Subscribe to one or more channels

Examples

let mut subscriber = client.subscriber().await?;

// Subscribe to multiple channels
subscriber.subscribe(vec![
    "news".to_string(),
    "updates".to_string(),
    "alerts".to_string()
]).await?;

pub async fn unsubscribe(&mut self, channels: Vec<String>) -> RedisResult<()>

Unsubscribe from one or more channels

Examples

let mut subscriber = client.subscriber().await?;
subscriber.subscribe(vec!["news".to_string()]).await?;

// Later, unsubscribe
subscriber.unsubscribe(vec!["news".to_string()]).await?;

pub async fn psubscribe(&mut self, patterns: Vec<String>) -> RedisResult<()>

Subscribe to one or more patterns

Patterns support glob-style matching:

• * matches any sequence of characters
• ? matches any single character
• [abc] matches any character in the set

Examples

let mut subscriber = client.subscriber().await?;

// Subscribe to all channels starting with "news"
subscriber.psubscribe(vec!["news*".to_string()]).await?;

// Subscribe to all channels ending with "log"
subscriber.psubscribe(vec!["*log".to_string()]).await?;

pub async fn punsubscribe(&mut self, patterns: Vec<String>) -> RedisResult<()>

Unsubscribe from one or more patterns

pub async fn next_message(&mut self) -> RedisResult<Option<PubSubMessage>>

Get the next message from subscribed channels

This method will block until a message is received or an error occurs.

Examples

let mut subscriber = client.subscriber().await?;
subscriber.subscribe(vec!["news".to_string()]).await?;

// Wait for the next message
if let Some(message) = subscriber.next_message().await? {
    println!("Received: {} on {}", message.payload, message.channel);
}

pub async fn next_message_timeout( &mut self, duration: Duration, ) -> RedisResult<Option<PubSubMessage>>

Get the next message with a timeout

Examples

let mut subscriber = client.subscriber().await?;
subscriber.subscribe(vec!["news".to_string()]).await?;

// Wait for a message with 5 second timeout
match subscriber.next_message_timeout(Duration::from_secs(5)).await? {
    Some(message) => println!("Received: {}", message.payload),
    None => println!("No message received within timeout"),
}

pub fn subscribed_channels(&self) -> Vec<String>

Get a list of currently subscribed channels

pub fn subscribed_patterns(&self) -> Vec<String>

Get a list of currently subscribed patterns

pub fn is_subscribed_to_channel(&self, channel: &str) -> bool

Check if subscribed to a specific channel

pub fn is_subscribed_to_pattern(&self, pattern: &str) -> bool

Check if subscribed to a specific pattern

Trait Implementations

impl Stream for Subscriber

Stream implementation for Subscriber

type Item = Result<PubSubMessage, RedisError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.