Struct multistream_batch::channel::tx_buf_batch::TxBufBatchChannel

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

Batches items in internal buffer up to max_size items or until max_duration has elapsed since the first item appended to the batch. Reference to each item is returned for every received item as soon as they are received.

The current batch can be retried. Iteration will yield not committed items again.

Implementations

impl<I: Debug> TxBufBatchChannel<I>

pub fn new(
    max_size: usize,
    max_duration: Duration,
    channel_size: usize
) -> (CommandSender<I>, TxBufBatchChannel<I>)

Creates batch given maximum batch size in the number of items stored (max_size) and maximum duration that batch can last (max_duration) 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 CommandSender 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(CommandSender<I>) + Send + 'static
) -> TxBufBatchChannel<I> where
    I: Send + 'static, 

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

pub fn next(
    &mut self
) -> Result<TxBufBatchChannelResult<'_, I>, EndOfStreamError>

Gets next item reference received by the batch or signal that the batch is now complete and can be retried or committed.

This call will block until batch becomes ready.

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

pub fn pop(&mut self) -> Option<I>

Pops last item returned by next from internal buffer - it won’t be retried.

Can be called multiple times to consume the internal buffer starting at last next item position.

pub fn is_disconnected(&self) -> bool

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

pub fn retry(&mut self)

Restarts batch making self.next() to iterate already appended items starting from oldest one in current batch.

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 as_slice(&self) -> &[I]

Returns slice of internal item buffer.

pub fn len(&self) -> usize

Returns number of buffered items.

pub fn batch_len(&self) -> usize

Returns number of buffered items that were already visited by the next call in current batch.

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

Converts into internal item buffer.

pub fn drain_to_end(self) -> DrainToEnd<I>

Converts to an iterator that will drain all buffered items first and then all items from the channel.

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

Splits into BufBatch item buffer and channel Receiver end.

Trait Implementations

impl<I: Debug> Debug for TxBufBatchChannel<I>

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

Formats the value using the given formatter.