Struct vector_common::finalizer::FinalizerSet

pub struct FinalizerSet<T, S> { /* private fields */ }

The FinalizerSet framework here is a mechanism for creating a stream of acknowledged (finalized) event batch identifiers from a source as done in a single background task. It does this by pushing the batch status receiver along with an identifier into either a FuturesOrdered or FuturesUnordered, waiting on the stream of acknowledgements that comes out, extracting just the identifier and sending that into the returned stream. The type T is the source-specific data associated with each entry.

Implementations

impl<T, S> FinalizerSet<T, S>

where T: Send + Debug + 'static, S: FuturesSet<FinalizerFuture<T>> + Default + Send + Unpin + 'static,

pub fn new( shutdown: Option<ShutdownSignal>, ) -> (Self, BoxStream<'static, (BatchStatus, T)>)

Produce a finalizer set along with the output stream of received acknowledged batch identifiers.

The output stream will end when the source closes the producer side of the channel, and acknowledgements in the channel are drained.

If the optional shutdown signal is provided, the output stream will end immediately when a shutdown signal is received. This is not recommended, and can cause some acknowledgements to go unprocessed. Sources may process the message(s) that correspond to those acknowledgements again.

pub fn maybe_new( maybe: bool, shutdown: Option<ShutdownSignal>, ) -> (Option<Self>, BoxStream<'static, (BatchStatus, T)>)

This returns an optional finalizer set along with a generic stream of acknowledged identifiers. In the case the finalizer is not to be used, a special empty stream is returned that is always pending and so never wakes.

pub fn add(&self, entry: T, receiver: BatchStatusReceiver)

pub fn flush(&self)

Trait Implementations

impl<T: Debug, S: Debug> Debug for FinalizerSet<T, S>

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

Formats the value using the given formatter.