Struct StreamBatchContext 

pub struct StreamBatchContext { /* private fields */ }

Batch context for a batched Redis Streams subscription: what the whole subscription shares.

The runtime builds one per dispatched batch from the batch’s first delivery, and a batch body reads it by keys key with ctx.context(..). Per-delivery data (the entry id, the position that redelivers one entry) has no place here, because a batch spans many deliveries: it rides the batch’s own elements instead, read off each element’s typed header contract. Keeping this a separate type from StreamContext is what rejects a batch body asking for per-delivery fields at compile time.

Examples

use ruststream_fred::stream::prelude::*;

/// A batch that saw the poison marker rewinds the group once the batch is settled.
#[subscriber(RedisStream::new("orders").group("workers"))]
async fn work(
    batch: &[Order],
    ctx: &mut Context<'_, StreamBatchContext>,
) -> HandlerOutcome {
    if batch.iter().any(|order| order.id == 0)
        && ctx
            .context(keys::SeekHandle)
            .seek(RedisGroupPosition::beginning())
            .await
            .is_err()
    {
        return HandlerOutcome::retry();
    }
    HandlerOutcome::ack()
}

Implementations

impl StreamBatchContext

pub fn consumer_group(&self) -> &str

The consumer group every delivery of this batch was read through.

pub const fn seeker(&self) -> &RedisGroupSeeker

The handle repositioning this subscription’s consumer group.

pub const fn pool(&self) -> &Pool

The broker’s connection pool, for a command whose answer the batch needs now.

Trait Implementations

impl BuildBatchContext<RedisMessage> for StreamBatchContext

fn build(first: &RedisMessage) -> Self

Builds the context value by reading subscription-scoped fields out of the batch’s first delivery, or out of the batch itself where it lends its values as one slice.

impl Clone for StreamBatchContext

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamBatchContext

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

Formats the value using the given formatter.

impl Field<StreamBatchContext> for FredPool

type Value<'a> = &'a Pool

The value read through this key, borrowed from the source for 'a.

fn get(self, src: &StreamBatchContext) -> &Pool

Reads this key’s field out of src.

impl Field<StreamBatchContext> for SeekHandle

type Value<'a> = &'a RedisGroupSeeker

The value read through this key, borrowed from the source for 'a.

fn get(self, src: &StreamBatchContext) -> &RedisGroupSeeker

Reads this key’s field out of src.

impl Field<StreamBatchContext> for ConsumerGroup

type Value<'a> = &'a str

The value read through this key, borrowed from the source for 'a.

fn get(self, src: &StreamBatchContext) -> &str

Reads this key’s field out of src.