Struct Subscriber 

pub struct Subscriber { /* private fields */ }

One subscribed connection. Owns either a TCP socket or an in-process Subscription; the variant is chosen by the URL scheme in Subscriber::open / Subscriber::connect.

Implementations

impl Subscriber

pub fn connect(url: &str) -> Result<Self>

Open a fresh connection without subscribing to anything yet. Call Self::subscribe / Self::psubscribe next.

Accepted URLs:

• kevy://, redis://, tcp:// — TCP RESP server
• mem://<name>, file:///path — in-process shared bus
• mem:// (anonymous), rediss://, kevys://, redis://user:pass@… are rejected with io::ErrorKind::Unsupported

pub fn open(url: &str, channels: &[&[u8]]) -> Result<Self>

Open and subscribe to one or more channels in one step. Returns ErrorKind::InvalidInput if channels is empty (use Self::connect for an empty start).

pub fn subscribe(&mut self, channels: &[&[u8]]) -> Result<()>

SUBSCRIBE channel [channel ...]. Per-channel Subscribe acks are delivered via Self::recv.

pub fn psubscribe(&mut self, patterns: &[&[u8]]) -> Result<()>

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

pub fn unsubscribe(&mut self, channels: &[&[u8]]) -> Result<()>

UNSUBSCRIBE [channel ...]. Empty channels unsubscribes from every channel (Redis wire semantics).

pub fn punsubscribe(&mut self, patterns: &[&[u8]]) -> Result<()>

PUNSUBSCRIBE [pattern ...]. Empty patterns unsubscribes from every pattern.

pub fn recv(&mut self) -> Result<PubsubEvent>

Block until the next pubsub frame arrives. Apply Self::set_read_timeout for bounded blocking. Connection close / bus tear-down yields ErrorKind::UnexpectedEof.

pub fn set_read_timeout(&mut self, dur: Option<Duration>) -> Result<()>

Apply (or clear) a read timeout. After setting Some(dur), Self::recv returns an io::Error of kind WouldBlock / TimedOut when no frame arrives within dur.

Trait Implementations

impl Debug for Subscriber

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

Formats the value using the given formatter.