Struct RedisPublisher 

pub struct RedisPublisher { /* private fields */ }

Redis publisher built on a shared fred connection pool. Cheap to clone.

Holds the broker’s shared connection cell, so a publisher created before the broker connects resolves the pool on first use; publishing before Broker::connect returns RedisError::NotConnected.

Publisher::publish appends the message to the stream named by OutgoingMessage::name with XADD <name> * .... The payload and headers are encoded as entry fields (see crate::RedisStream for the consuming side).

Transactions

On standalone and sentinel topologies the publisher implements TransactionalPublisher: begin_transaction starts buffering published messages, commit flushes the buffer in publish order through a single fred pipeline, and abort discards it. Cluster does not support it (buffered keys may live on different nodes), so begin_transaction returns RedisError::InvalidOptions there. Clones of a handle share the same open transaction buffer.

Trait Implementations

impl Clone for RedisPublisher

fn clone(&self) -> RedisPublisher

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedisPublisher

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

Formats the value using the given formatter.

impl Publisher for RedisPublisher

type Error = RedisError

The error type returned by publish.

async fn publish(&self, msg: OutgoingMessage<'_>) -> Result<(), Self::Error>

Publishes a message to the broker.

impl TransactionalPublisher for RedisPublisher

async fn begin_transaction(&self) -> Result<(), Self::Error>

Starts buffering. A no-op if a transaction is already open (it continues).

Errors

Returns RedisError::InvalidOptions on a cluster topology, which cannot offer multi-key transactions.

async fn commit(&self) -> Result<(), Self::Error>

Flushes the buffered XADDs in publish order through one pipeline, then clears the transaction. A commit with no open transaction is a no-op.

Errors

Returns RedisError::NotConnected if the broker never connected, or RedisError::Publish if the pipeline fails. On failure the buffer is already cleared.

async fn abort(&self) -> Result<(), Self::Error>

Discards the buffered messages. An abort with no open transaction is a no-op.