Struct RedisList 

pub struct RedisList { /* private fields */ }

Describes one list subscription against crate::RedisBroker.

Examples

use std::time::Duration;
use ruststream_fred::RedisList;

let simple = RedisList::new("jobs");
let reliable = RedisList::new("jobs").reliable().block(Duration::from_secs(2));

Implementations

impl RedisList

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

A simple (at-most-once) BRPOP work-queue consumer on key.

pub const fn reliable(self) -> Self

Switches to reliable (at-least-once) mode: entries move to a processing list and are removed on ack.

pub fn processing(self, key: impl Into<String>) -> Self

Sets the processing-list key used in reliable mode. Defaults to <key>.processing.

pub const fn block(self, block: Duration) -> Self

How long one blocking pop waits before looping. Defaults to 5 seconds.

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 dead_letter(self, key: impl Into<String>) -> Self

In reliable mode, routes dropped and poison entries to the named dead-letter list (LPUSH) instead of discarding them, tagged with DEAD_LETTER_REASON_HEADER. Off by default. Has no effect on a simple list, which cannot ack. See [crate::deadletter].

pub const fn max_deliveries(self, max: u64) -> Self

In reliable mode, caps how many times an entry may be nack(requeue = true)-ed before it is treated as poison (dead-lettered or, with no dead-letter list, discarded). Off by default.

Lists have no native delivery counter, so this tracks the framework retry-count header carried in the entry’s envelope.

pub const fn min_idle(self, min_idle: Duration) -> Self

How long a claimed reliable-mode entry may sit idle on the processing list before the recovery watchdog returns it to the main list. Required for (and only meaningful with) recovery_zset.

It has no default and must exceed the longest legitimate handler runtime: set it too low and a healthy consumer’s in-flight entry gets recovered and processed twice.

pub fn recovery_zset(self, key: impl Into<String>) -> Self

Opts reliable mode into orphan recovery, naming the ZSET key that tracks in-flight claims.

Off by default (a dead consumer’s entry stays stranded on the processing list). The key has no sane default, so it is named explicitly here; pair it with min_idle, which is required when recovery is on. Reliable mode is implied. See [crate::recovery].

pub const fn recovery_ttl(self, ttl: Duration) -> Self

An optional auto-cleanup TTL on the recovery ZSET key (refreshed on every claim).

When set it must exceed min_idle (and the longest legitimate handler runtime), or in-flight tracking is dropped before the watchdog can act.

pub fn key(&self) -> &str

The list key this subscription consumes.

Trait Implementations

impl Clone for RedisList

fn clone(&self) -> RedisList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedisList

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

Formats the value using the given formatter.

impl SubscriptionSource<RedisBroker> for RedisList

type Subscriber = RedisListSubscriber

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.