Struct StreamConsumer 

pub struct StreamConsumer<H: StreamHandler> { /* private fields */ }

A Redis Stream consumer that reads messages, dispatches them to a handler, and manages ACKs, retries (via XCLAIM), and dead-lettering.

The consumer uses XREADGROUP with consumer groups for reliable, at-least-once delivery. Messages that fail processing are left pending and automatically reclaimed after min_idle_ms via periodic XCLAIM. Messages exceeding max_retries are moved to a dead-letter stream.

Implementations

impl<H: StreamHandler> StreamConsumer<H>

pub fn new(pool: Pool, config: StreamConfig, handler: H) -> Self

Create a new stream consumer.

pub async fn run(&self, shutdown_rx: Receiver<()>) -> StreamResult<()>

Run the consumer loop until a shutdown signal is received.

This method:

1. Ensures the consumer group exists (creates it if not).
2. Reads messages via XREADGROUP in a cancellation-safe inner loop.
3. Processes messages outside select! to prevent partial execution.
4. Periodically reclaims idle pending messages via XCLAIM.