Struct ConnectedRedisBroker 

pub struct ConnectedRedisBroker { /* private fields */ }

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

Every subscription and every publisher is reached from here, so “not connected” is not representable. ConnectedBroker::shutdown consumes it, which makes a publish or subscribe after shutdown a compile error for the owner of the handle.

Implementations

impl ConnectedRedisBroker

pub async fn subscribe( &self, def: RedisStream, ) -> Result<RedisSubscriber, RedisError>

Opens a stream subscription described by def.

Ensures the consumer group exists (XGROUP CREATE ... MKSTREAM, ignoring an already-existing group) before returning the subscriber.

Errors

Returns RedisError::ShutDown when the connection was already torn down, RedisError::InvalidOptions when def names no consumer group, or RedisError::Subscribe when the group cannot be created.

pub async fn subscribe_pubsub( &self, def: RedisPubSub, ) -> Result<RedisPubSubSubscriber, RedisError>

Opens a Pub/Sub subscription described by def on a dedicated client.

Errors

Returns RedisError::InvalidOptions for an invalid mode/pattern combination, RedisError::ShutDown when the connection was already torn down, RedisError::Connect when the dedicated client cannot connect, or RedisError::Subscribe when the subscribe command fails.

pub async fn subscribe_list( &self, def: RedisList, ) -> Result<RedisListSubscriber, RedisError>

Opens a list (work-queue) subscription described by def.

Errors

Returns RedisError::ShutDown when the connection was already torn down, or RedisError::InvalidOptions when def names a recovery ZSET without a min_idle.

pub fn publisher(&self) -> RedisPublisher

Returns a stream publisher (XADD) bound to this connection.

pub fn pubsub_publisher( &self, publish: RedisPubSubPublish, ) -> RedisPubSubPublisher

Returns a Pub/Sub publisher configured by publish (mode and envelope codec).

pub fn list_publisher(&self, publish: RedisListPublish) -> RedisListPublisher

Returns a list publisher (LPUSH) configured by publish (envelope codec and key TTL).

pub fn pool_handle(&self) -> Result<Pool, RedisError>

Returns a clone of the underlying pool, for advanced operations not covered by the wrapper.

Errors

Returns RedisError::ShutDown once the connection was torn down.

Trait Implementations

impl ConnectedBroker for ConnectedRedisBroker

async fn shutdown(self) -> Result<Self::Closed, Self::Error>

Closes every pooled connection and marks the shared connection dead, so publishers handed out earlier report RedisError::ShutDown instead of running against a closed pool.

Errors

Returns RedisError::Connect when the QUIT roundtrip fails.

type Error = RedisError

The error type returned by connected-broker operations.

type Closed = ClosedRedisBroker

The terminal witness returned by shutdown.

impl Debug for ConnectedRedisBroker

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

Formats the value using the given formatter.

impl DefaultPublish for ConnectedRedisBroker

type Policy = RedisPublish

The broker’s plain publish policy, constructible with its defaults.

impl PublishPolicy<ConnectedRedisBroker> for RedisListPublish

type Live = RedisListPublisher

The live form this policy pairs into: a Publisher for a leaf policy, or the live wiring form for a combinator stack (a typed publisher over a policy pairs into the same typed publisher over the live leaf).

async fn pair( self, connected: &ConnectedRedisBroker, ) -> Result<Self::Live, PairError>

Pairs the policy with a connected broker, producing the live publisher.

impl PublishPolicy<ConnectedRedisBroker> for RedisPublish

type Live = RedisPublisher

The live form this policy pairs into: a Publisher for a leaf policy, or the live wiring form for a combinator stack (a typed publisher over a policy pairs into the same typed publisher over the live leaf).

async fn pair( self, connected: &ConnectedRedisBroker, ) -> Result<Self::Live, PairError>

Pairs the policy with a connected broker, producing the live publisher.

impl PublishPolicy<ConnectedRedisBroker> for RedisPubSubPublish

type Live = RedisPubSubPublisher

The live form this policy pairs into: a Publisher for a leaf policy, or the live wiring form for a combinator stack (a typed publisher over a policy pairs into the same typed publisher over the live leaf).

async fn pair( self, connected: &ConnectedRedisBroker, ) -> Result<Self::Live, PairError>

Pairs the policy with a connected broker, producing the live publisher.

impl Subscribe for ConnectedRedisBroker

type Subscriber = RedisSubscriber

The subscriber type opened by a by-name subscription.

async fn subscribe(&self, name: &str) -> Result<Self::Subscriber, Self::Error>

Opens a subscription to name, producing this broker’s Subscriber.

impl SubscriptionSource<ConnectedRedisBroker> 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, connected: &ConnectedRedisBroker, ) -> Result<Self::Subscriber, RedisError>

Opens the subscription against the connected broker. Called once at startup.

impl SubscriptionSource<ConnectedRedisBroker> for RedisPubSub

type Subscriber = RedisPubSubSubscriber

The subscriber type this source opens.

fn name(&self) -> &str

The name (subject / channel) this subscription binds to.

async fn subscribe( self, connected: &ConnectedRedisBroker, ) -> Result<Self::Subscriber, RedisError>

Opens the subscription against the connected broker. Called once at startup.

impl SubscriptionSource<ConnectedRedisBroker> for RedisStream

type Subscriber = RedisSubscriber

The subscriber type this source opens.

fn name(&self) -> &str

The name (subject / channel) this subscription binds to.

async fn subscribe( self, connected: &ConnectedRedisBroker, ) -> Result<Self::Subscriber, RedisError>

Opens the subscription against the connected broker. Called once at startup.