Struct RedisBroker 

pub struct RedisBroker { /* private fields */ }

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

Build it with standalone, cluster, sentinel, or from_pool. All four are synchronous and perform no I/O, so a Redis service composes with the synchronous #[ruststream::app] builder; the runtime dials once at startup through the consuming Broker::connect, which yields the ConnectedRedisBroker every subscription and publisher is reached from.

Examples

use ruststream::{Broker, ConnectedBroker};
use ruststream_fred::{RedisBroker, RedisStream};

let connected = RedisBroker::standalone("redis://localhost:6379").connect().await?;
let publisher = connected.publisher();
let sub = connected.subscribe(RedisStream::new("orders").group("workers")).await?;
let _closed = connected.shutdown().await?;

Implementations

impl RedisBroker

pub fn standalone(url: impl Into<String>) -> Self

Creates a standalone-topology broker that connects to url when Broker::connect runs.

pub fn cluster(nodes: impl IntoIterator<Item = impl Into<String>>) -> Self

Creates a Redis Cluster broker from one or more host:port seed nodes.

Only one reachable node is needed; fred discovers the rest of the cluster on connect.

pub fn sentinel( service: impl Into<String>, sentinels: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Creates a Sentinel-backed broker that tracks the primary named service, discovering it through the given sentinel host:port addresses.

pub fn from_pool(pool: Pool) -> Self

Wraps an already-connected fred pool. Useful for advanced configuration (TLS, cluster, sentinel, custom performance and reconnection policies).

Broker::connect adopts the pool instead of dialing; the config it was built from is reused for the dedicated clients Pub/Sub subscriptions need.

pub const fn pool(self, size: usize) -> Self

Sets the connection-pool size. Defaults to 4.

pub fn default_group(self, group: impl Into<String>) -> Self

Sets a broker-wide default consumer group, enabling the bare-string #[subscriber("key")] form (Redis Streams always read through a group). Without it a bare-string subscription returns RedisError::InvalidOptions; name the group per subscription with RedisStream::group instead.

pub fn credentials( self, username: impl Into<String>, password: impl Into<String>, ) -> Self

Sets the ACL username and password used to authenticate on connect, applied on every topology (standalone, cluster, sentinel).

This maps onto fred’s Config.username / Config.password, so authentication works beyond the standalone redis://user:pass@host URL, which the bare cluster / sentinel seed lists cannot express. Credentials set here override any in a standalone URL.

For a password-only AUTH (the legacy requirepass, no ACL user) use password.

Examples

use ruststream_fred::RedisBroker;

let broker = RedisBroker::cluster(["10.0.0.1:6379"]).credentials("worker", "s3cr3t");

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

Sets a password-only AUTH (no ACL username; the legacy requirepass form), on every topology. Use credentials for an ACL user plus password.

Examples

use ruststream_fred::RedisBroker;

let broker = RedisBroker::sentinel("mymaster", ["10.0.0.1:26379"]).password("s3cr3t");

pub fn tls(self, tls: impl Into<TlsConfig>) -> Self

Sets the TLS configuration used on connect, on every topology. Accepts a fred TlsConfig or anything convertible into one (for example a TlsConnector).

Available behind the tls-rustls, tls-rustls-ring, or tls-native-tls feature; a standalone broker can also enable TLS through a rediss:// / valkeys:// URL. The fred re-exports TlsConfig / TlsConnector provide default_rustls() / default_native_tls() shorthands for system-trust setups.

Examples

use ruststream_fred::{RedisBroker, TlsConfig};

fn build(tls: TlsConfig) -> RedisBroker {
    RedisBroker::cluster(["10.0.0.1:6379"]).tls(tls)
}

pub fn sentinel_credentials( self, username: impl Into<String>, password: impl Into<String>, ) -> Self

Sets distinct credentials for authenticating to the sentinel nodes, separate from the data-node credentials. Only meaningful on the sentinel topology.

Available behind the sentinel-auth feature.

Examples

use ruststream_fred::RedisBroker;

let broker = RedisBroker::sentinel("mymaster", ["10.0.0.1:26379"])
    .credentials("worker", "data-pass")
    .sentinel_credentials("sentinel-user", "sentinel-pass");

pub fn sentinel_password(self, password: impl Into<String>) -> Self

Sets a password-only credential for authenticating to the sentinel nodes. Use sentinel_credentials for an ACL user plus password.

Available behind the sentinel-auth feature.

Examples

use ruststream_fred::RedisBroker;

let broker = RedisBroker::sentinel("mymaster", ["10.0.0.1:26379"])
    .sentinel_password("sentinel-pass");

pub fn credential_provider(self, provider: Arc<dyn CredentialProvider>) -> Self

Sets a dynamic credential provider that supplies (and can rotate) the username/password on each AUTH / HELLO, for IAM-style auth. Takes precedence over static credentials.

Available behind the credential-provider feature.

Examples

use std::sync::Arc;
use ruststream_fred::{CredentialProvider, RedisBroker};

fn build(provider: Arc<dyn CredentialProvider>) -> RedisBroker {
    RedisBroker::standalone("redis://localhost:6379").credential_provider(provider)
}

Trait Implementations

impl Broker for RedisBroker

async fn connect(self) -> Result<Self::Connected, Self::Error>

Opens (or adopts) the connection pool, consuming the unconnected form.

Errors

Returns RedisError::Connect when the recorded topology cannot be turned into a fred config or the pool cannot reach the server.

type Error = RedisError

The error type returned by broker-level operations.

type Connected = ConnectedRedisBroker

The connected form of this broker: the typed witness that connect succeeded.

fn bindable(self) -> Bindable<Self>

where Self: 'static,

Wraps the broker for publisher-token minting before registration: the returned Bindable hands out Bound tokens via its bind, and is itself what with_broker takes.

impl Clone for RedisBroker

fn clone(&self) -> RedisBroker

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedisBroker

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

Formats the value using the given formatter.

impl DescribeServer for RedisBroker

DescribeServer reports the configured Redis address (the first seed for cluster/sentinel).

fn describe_server(&self) -> ServerSpec

Returns the server coordinates for this broker.