Struct multistream_batch::channel::multi_buf_batch::MultiBufBatchChannel

pub struct MultiBufBatchChannel<K: Debug + Ord + Hash, I: Debug> { /* fields omitted */ }

Collects items into multiple batches based on the stream key. A batch may become ready after collecting max_size number of items or until max_duration has elapsed since the first item appended to the batch.

Batch item buffers are cached and reused to avoid allocations.

Implementations

impl<K, I> MultiBufBatchChannel<K, I> where
    K: Debug + Ord + Hash + Send + Clone + 'static,
    I: Debug + Send + 'static, 

pub fn new(
    max_size: usize,
    max_duration: Duration,
    channel_size: usize
) -> (Sender<Command<K, I>>, MultiBufBatchChannel<K, I>)

Crates new instance with given maximum batch size (max_size) and maximum duration (max_duration) that batch can last since the first item appended to it. Parameter channel_size defines the maximum number of messages that can be buffered between sender and receiver.

This method also returns Sender endpoint that can be used to send Commands.

Panics if max_size == 0.

pub fn with_producer_thread(
    max_size: usize,
    max_duration: Duration,
    channel_size: usize,
    producer: impl FnOnce(Sender<Command<K, I>>) + Send + 'static
) -> MultiBufBatchChannel<K, I>

Calls producer closure with Sender end of the channel in a newly started thread and returns MultiBufBatchChannel connected to that Sender.

pub fn next<'i>(&'i mut self) -> Result<(K, Drain<I>), EndOfStreamError>

Gets next ready batch as pair of batch stream key K and Drain iterator of its items.

This call will block until one of the batches becomes ready.

When the Sender end has dropped, this method returns with Err(EndOfStreamError) after all outstanding items were flushed.

pub fn outstanding(&self) -> impl Iterator<Item = &K>

Lists keys of outstanding batches.

pub fn clear(&mut self, key: &K)

Starts new batch dropping all buffered items.

pub fn drain(&mut self, key: &K) -> Option<Drain<I>>

Starts new batch by draining all buffered items.

pub fn flush(&mut self) -> Vec<(K, Vec<I>)>

Flushes all outstanding batches starting from oldest.

pub fn get(&self, key: &K) -> Option<&[I]>

Returns slice of internal item buffer of given outstanding batch.

pub fn clear_cache(&mut self)

Drops cached batch buffers.

pub fn stats(&self) -> Stats

Provides usage statistics.

pub fn split(self) -> (MultiBufBatch<K, I>, Receiver<Command<K, I>>)

Splits into MultiBufBatch item buffer and channel Receiver end.

Trait Implementations

impl<K: Debug + Ord + Hash, I: Debug> Debug for MultiBufBatchChannel<K, I>

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

Formats the value using the given formatter.