Struct re_log_types::DataTableBatcher

pub struct DataTableBatcher { /* private fields */ }

Implements an asynchronous batcher that coalesces DataRows into DataTables based upon the thresholds defined in the associated DataTableBatcherConfig.

Multithreading and ordering

DataTableBatcher can be cheaply clone and used freely across any number of threads.

Internally, all operations are linearized into a pipeline:

• All operations sent by a given thread will take effect in the same exact order as that thread originally sent them in, from its point of view.
• There isn’t any well defined global order across multiple threads.

This means that e.g. flushing the pipeline (Self::flush_blocking) guarantees that all previous data sent by the calling thread has been batched and sent down the channel returned by DataTableBatcher::tables; no more, no less.

Shutdown

The batcher can only be shutdown by dropping all instances of it, at which point it will automatically take care of flushing any pending data that might remain in the pipeline.

Shutting down cannot ever block.

Implementations

impl DataTableBatcher

pub fn new( config: DataTableBatcherConfig ) -> Result<Self, DataTableBatcherError>

Creates a new DataTableBatcher using the passed in config.

The returned object must be kept in scope: dropping it will trigger a clean shutdown of the batcher.

pub fn push_row(&self, row: DataRow)

Pushes a DataRow down the batching pipeline.

This will call DataRow::compute_all_size_bytes from the batching thread!

See DataTableBatcher docs for ordering semantics and multithreading guarantees.

pub fn flush_async(&self)

Initiates a flush of the pipeline and returns immediately.

This does not wait for the flush to propagate (see Self::flush_blocking). See DataTableBatcher docs for ordering semantics and multithreading guarantees.

pub fn flush_blocking(&self)

Initiates a flush the batching pipeline and waits for it to propagate.

See DataTableBatcher docs for ordering semantics and multithreading guarantees.

pub fn tables(&self) -> Receiver<DataTable>

Returns a shared channel in which are sent the batched DataTables.

Shutting down the batcher will close this channel.

See DataTableBatcher docs for ordering semantics and multithreading guarantees.

Trait Implementations

impl Clone for DataTableBatcher

fn clone(&self) -> DataTableBatcher

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.