Crate ruststream_fred 

Redis / Valkey broker implementation for RustStream, backed by fred.

This crate implements the RustStream broker contract over Redis Streams: durable consumer groups with acknowledgement, redelivery, and crash recovery. Subjects are stream keys; a subscription reads through a consumer group, either off the fresh tail (RedisStream::new) or reclaiming another consumer’s stale pending entries (RedisStream::reclaim).

Settlement follows the republish-retry model: ack is XACK, nack(requeue = true) re-appends a copy to the same stream then acks the original, and nack(requeue = false) acks to drop.

The lifecycle is the framework’s ladder of consuming transitions: RedisBroker records the topology synchronously, Broker::connect yields the ConnectedRedisBroker that every subscription and publisher is reached from, and ConnectedBroker::shutdown yields the terminal ClosedRedisBroker. Publishers are declared as a policy (RedisPublish, RedisPubSubPublish, RedisListPublish) that pairs with the connected form.

Modules

context

Optional typed per-delivery context exposing native Redis metadata by compile-time key. Optional typed per-delivery context exposing native Redis metadata, one struct per transport.

testing

In-process Redis test transport used by application unit tests and the conformance suite.

Structs

ClosedRedisBroker

The terminal witness returned by shutting down a ConnectedRedisBroker.

ConnectedRedisBroker

The typed witness that Broker::connect succeeded: it owns the live fred pool.

EntryId

A Redis Streams entry id: the <milliseconds>-<sequence> pair the server assigns to every entry.

RedisBroker

An unconnected Redis broker: the recorded topology and its options, no I/O performed yet.

RedisGroupSeeker

Moves a consumer group’s cursor.

RedisList

Describes one list subscription against a ConnectedRedisBroker.

RedisListMessage

A list-queue delivery. In simple mode ack / nack are unsupported; in reliable mode ack removes the entry from the processing list and nack either returns it or drops it.

RedisListPublish

The declaration half of the list publisher: envelope codec and key TTL, no connection.

RedisListPublisher

Publishes onto a list with LPUSH, so right-popping consumers see FIFO order: a RedisListPublish policy paired with a connection.

RedisListSubscriber

A list-backed work-queue subscription.

RedisMessage

A Redis Streams delivery, read from a consumer group via XREADGROUP or XAUTOCLAIM.

RedisPubSub

Describes one Pub/Sub subscription against a ConnectedRedisBroker.

RedisPubSubMessage

A Pub/Sub delivery. ack / nack are unsupported (Pub/Sub has no acknowledgement).

RedisPubSubPublish

The declaration half of the Pub/Sub publisher: delivery mode and envelope codec, no connection.

RedisPubSubPublisher

Publishes Pub/Sub messages with PUBLISH (classic) or SPUBLISH (sharded): a RedisPubSubPublish policy paired with a connection.

RedisPubSubSubscriber

A Pub/Sub subscription backed by a dedicated fred client, so its message stream and channel state are isolated from other subscribers and from the publishing pool.

RedisPublish

The declaration half of the stream publisher: pure policy, constructible anywhere.

RedisPublisher

The live stream publisher: RedisPublish paired with a connection. Cheap to clone.

RedisStream

Describes one Redis Streams subscription against a ConnectedRedisBroker.

RedisSubscriber

A Redis Streams subscription bound to a consumer group.

RedisTransaction

An owned Redis transaction, opened by transaction on a RedisPublisher.

TlsConfig

TLS configuration for a client.

Enums

DelayedRetry

How a subscription should handle retry_after / nack_after delays.

PubSubMode

Pub/Sub delivery mode. Defaults to Classic.

RedisError

Errors surfaced by the Redis broker implementation.

RedisGroupPosition

Where a consumer group’s cursor sits, for RedisGroupSeeker::seek and the start_at(..) clause of #[subscriber].

StreamStart

Where a freshly created consumer group starts reading from. Only consulted when the group does not yet exist; an existing group keeps its own cursor.

TlsConnector

An enum for interacting with various TLS libraries and interfaces.

Constants

DEAD_LETTER_REASON_HEADER

Header naming why a message was dead-lettered: [REASON_DROPPED] or [REASON_MAX_DELIVERIES].

DELIVERY_COUNT_HEADER

Header exposing the native Redis Streams delivery count on a reclaimed delivery, so a handler can branch or dead-letter manually.

IDLE_MS_HEADER

Header exposing how long (milliseconds) a reclaimed delivery had been pending.

PARTITION_KEY_HEADER

The well-known header key for per-message routing / partitioning.

Traits

CredentialProvider

A trait that can be used to override the credentials used in each AUTH or HELLO command.