Struct hedwig::publish::PublishBatch

pub struct PublishBatch { /* fields omitted */ }

This is supported on crate feature publish only.

A convenience builder for publishing in batches.

Implementations

impl PublishBatch

pub fn new() -> Self

Construct a new batch.

pub fn len(&self) -> usize

Number of messages currently queued.

pub fn is_empty(&self) -> bool

Whether the batch is empty.

pub fn push(&mut self, topic: Topic, validated: ValidatedMessage) -> &mut Self

Add an already validated message to be published in this batch.

pub fn message<M: EncodableMessage>(
    &mut self,
    validator: &M::Validator,
    msg: M
) -> Result<&mut Self, Error>

Validate and add a message to be published in this batch.

pub fn publish<P>(self, publisher: &P) -> PublishBatchStream<P::PublishStream> where
    P: Publisher,
    P::PublishStream: Unpin, 

Publish all the enqueued messages, batching them for high efficiency.

The order in which messages were added to the batch and the order of messages as seen by the publisher is not strictly preserved. As thus, the output stream will not preserve the message ordering either.

Some kinds of errors that occur during publishing may not be transient. An example of such an error is attempting to publish a too large message with the GooglePubSubPublisher. For errors like these retrying is most likely incorrect as they would just fail again. Publisher-specific error types may have methods to make a decision easier.

Trait Implementations

impl Debug for PublishBatch

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

Formats the value using the given formatter.

impl Default for PublishBatch

fn default() -> PublishBatch

Returns the “default value” for a type.