Struct Subscription 

pub struct Subscription { /* private fields */ }

A handle to one subscription — owns the receive end of the bus channel.

Drop unsubscribes from everything automatically. While the handle is alive, recv / recv_timeout / try_recv drain queued PubsubFrames in arrival order.

Implementations

impl Subscription

pub fn subscribe(&mut self, channels: &[&[u8]])

SUBSCRIBE channel [channel ...]. Per-channel Subscribe acks are enqueued onto the receive queue in order.

pub fn psubscribe(&mut self, patterns: &[&[u8]])

PSUBSCRIBE pattern [pattern ...]. Patterns use Redis glob syntax (*, ?, [abc]).

pub fn unsubscribe(&mut self, channels: &[&[u8]])

UNSUBSCRIBE [channel ...]. Empty channels removes every channel subscription this handle holds (matching the Redis wire shape: individual ack frames for each channel that was actually removed, or a single Unsubscribe { channel: None } if none were held).

pub fn punsubscribe(&mut self, patterns: &[&[u8]])

PUNSUBSCRIBE [pattern ...]. Empty patterns removes every pattern.

pub fn recv(&self) -> Result<PubsubFrame>

Block until one frame is queued. Err(io::ErrorKind::UnexpectedEof) once the underlying bus tears down (last Store clone dropped).

pub fn recv_timeout(&self, dur: Duration) -> Result<PubsubFrame>

Bounded blocking recv. Err(io::ErrorKind::TimedOut) when dur elapses; Err(io::ErrorKind::UnexpectedEof) when the bus is gone.

pub fn try_recv(&self) -> Result<Option<PubsubFrame>>

Non-blocking recv. Ok(None) if the queue is empty; Err(UnexpectedEof) when the bus is gone.

Trait Implementations

impl Debug for Subscription

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

Formats the value using the given formatter.

impl Drop for Subscription

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.