Struct RedisPubSub 

pub struct RedisPubSub { /* private fields */ }

Describes one Pub/Sub subscription against crate::RedisBroker.

Examples

use ruststream_fred::{PubSubMode, RedisPubSub};

let classic = RedisPubSub::new("events");
let sharded = RedisPubSub::new("events").mode(PubSubMode::Sharded);
let pattern = RedisPubSub::new("events.*").pattern(); // classic only

Implementations

impl RedisPubSub

pub fn new(channel: impl Into<String>) -> Self

A subscription on channel (an exact channel by default; see pattern).

pub const fn mode(self, mode: PubSubMode) -> Self

Sets the delivery mode. Defaults to PubSubMode::Classic.

pub const fn pattern(self) -> Self

Treats the channel as a glob pattern (PSUBSCRIBE). Classic mode only; combining it with PubSubMode::Sharded is rejected at subscribe time.

pub fn codec(self, codec: impl Codec + 'static) -> Self

Decodes the header/payload envelope with codec (must match the publisher). Without it the default lossless binary framing is used.

pub fn channel(&self) -> &str

The channel (or pattern) this subscription listens on.

Trait Implementations

impl Clone for RedisPubSub

fn clone(&self) -> RedisPubSub

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RedisPubSub

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

Formats the value using the given formatter.

impl SubscriptionSource<RedisBroker> for RedisPubSub

type Subscriber = RedisPubSubSubscriber

The subscriber type this source opens.

fn name(&self) -> &str

The name (subject / channel) this subscription binds to.

async fn subscribe( self, broker: &RedisBroker, ) -> Result<Self::Subscriber, RedisError>

Opens the subscription against broker. Called once, after Broker::connect.