Struct multistream_batch::channel::buf_batch::BufBatchChannel

pub struct BufBatchChannel<I: Debug> { /* fields omitted */ }

Batches items in internal buffer up to max_size items or until max_duration has elapsed since first item was appended to the batch.

Methods

impl<I: Debug> BufBatchChannel<I>

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

Creates batch given maximum batch size in number of items (max_size) and maximum duration that batch can last (max_duration) since first item appended to it. It also returns Sender endpoint into which Commands can be sent.

Panics if max_size == 0.

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

Crates batch calling producer closure with Sender end of the channel in newly started thread.

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

Gets next ready batch as Drain iterator of its items.

This call will block until batch becomes ready.

Returns Err(EndOfStreamError) after Sender end was dropped and all batched items were flushed.

pub fn is_disconnected(&self) -> bool

Checks if previous self.next() call found channel to be disconnected.

pub fn clear(&mut self)

Starts new batch dropping all buffered items.

pub fn drain(&mut self) -> Drain<I>

Starts new batch by draining all buffered items.

pub fn into_vec(self) -> Vec<I>

Converts into internal item buffer.

pub fn as_slice(&self) -> &[I]

Returns slice of internal item buffer.

Trait Implementations

impl<I: Debug> Debug for BufBatchChannel<I>

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

Formats the value using the given formatter.