Struct re_data_store::GarbageCollectionOptions

pub struct GarbageCollectionOptions {
    pub target: GarbageCollectionTarget,
    pub time_budget: Duration,
    pub protect_latest: usize,
    pub purge_empty_tables: bool,
    pub dont_protect: HashSet<ComponentName>,
    pub enable_batching: bool,
}

Fields

target: GarbageCollectionTarget

What target threshold should the GC try to meet.

time_budget: Duration

How long the garbage collection in allowed to run for.

Trades off latency for throughput:

• A smaller time_budget will clear less data in a shorter amount of time, allowing for a more responsive UI at the cost of more GC overhead and more frequent runs.
• A larger time_budget will clear more data in a longer amount of time, increasing the chance of UI freeze frames but decreasing GC overhead and running less often.

The default is an unbounded time budget (i.e. throughput only).

protect_latest: usize

How many component revisions to preserve on each timeline.

purge_empty_tables: bool

Whether to purge tables that no longer contain any data

dont_protect: HashSet<ComponentName>

Components which should not be protected from GC when using protect_latest

enable_batching: bool

Whether to enable batched bucket drops.

Disabled by default as it is currently slower in most cases (somehow).

Implementations

impl GarbageCollectionOptions

pub fn gc_everything() -> Self

Trait Implementations

impl Clone for GarbageCollectionOptions

fn clone(&self) -> GarbageCollectionOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GarbageCollectionOptions

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

Formats the value using the given formatter.