Struct rerun::external::re_log_types::DataTableBatcherConfig

pub struct DataTableBatcherConfig {
    pub flush_tick: Duration,
    pub flush_num_bytes: u64,
    pub flush_num_rows: u64,
    pub max_commands_in_flight: Option<u64>,
    pub max_tables_in_flight: Option<u64>,
    pub hooks: BatcherHooks,
}

Defines the different thresholds of the associated DataTableBatcher.

See Self::default and Self::from_env.

Fields

flush_tick: Duration

Duration of the periodic tick.

flush_num_bytes: u64

Flush if the accumulated payload has a size in bytes equal or greater than this.

The resulting DataTable might be larger than flush_num_bytes!

flush_num_rows: u64

Flush if the accumulated payload has a number of rows equal or greater than this.

max_commands_in_flight: Option<u64>

Size of the internal channel of commands.

Unbounded if left unspecified.

max_tables_in_flight: Option<u64>

Size of the internal channel of DataTables.

Unbounded if left unspecified.

hooks: BatcherHooks

Callbacks you can install on the DataTableBatcher.

Implementations

impl DataTableBatcherConfig

pub const DEFAULT: DataTableBatcherConfig = _

Default configuration, applicable to most use cases.

pub const ALWAYS: DataTableBatcherConfig = _

Always flushes ASAP.

pub const NEVER: DataTableBatcherConfig = _

Never flushes unless manually told to.

pub const ENV_FLUSH_TICK: &'static str = "RERUN_FLUSH_TICK_SECS"

Environment variable to configure Self::flush_tick.

pub const ENV_FLUSH_NUM_BYTES: &'static str = "RERUN_FLUSH_NUM_BYTES"

Environment variable to configure Self::flush_num_bytes.

pub const ENV_FLUSH_NUM_ROWS: &'static str = "RERUN_FLUSH_NUM_ROWS"

Environment variable to configure Self::flush_num_rows.

pub fn from_env() -> Result<DataTableBatcherConfig, DataTableBatcherError>

Creates a new DataTableBatcherConfig using the default values, optionally overridden through the environment.

See Self::apply_env.

pub fn apply_env(&self) -> Result<DataTableBatcherConfig, DataTableBatcherError>

Returns a copy of self, overriding existing fields with values from the environment if they are present.

See Self::ENV_FLUSH_TICK, Self::ENV_FLUSH_NUM_BYTES, Self::ENV_FLUSH_NUM_BYTES.

Trait Implementations

impl Clone for DataTableBatcherConfig

fn clone(&self) -> DataTableBatcherConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataTableBatcherConfig

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

Formats the value using the given formatter.

impl Default for DataTableBatcherConfig

fn default() -> DataTableBatcherConfig

Returns the “default value” for a type.

impl PartialEq for DataTableBatcherConfig

fn eq(&self, other: &DataTableBatcherConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DataTableBatcherConfig