Struct rerun::StoreDiff

pub struct StoreDiff {
    pub kind: StoreDiffKind,
    pub row_id: RowId,
    pub times: Vec<(Timeline, TimeInt)>,
    pub entity_path: EntityPath,
    pub cells: HashMap<ComponentName, DataCell, BuildHasherDefault<NoHashHasher<ComponentName>>>,
}

Everything needed to build custom StoreSubscribers. Describes an atomic change in the Rerun DataStore: a row has been added or deleted.

From a query model standpoint, the DataStore always operates one row at a time:

• The contents of a row (i.e. its columns) are immutable past insertion, by virtue of RowIds being unique and non-reusable.
• Similarly, garbage collection always removes all the data associated with a row in one go: there cannot be orphaned columns. When a row is gone, all data associated with it is gone too.

Refer to field-level documentation for more information.

Fields

kind: StoreDiffKind

Addition or deletion?

The store’s internals are opaque and don’t necessarily reflect the query model (e.g. there might be data in the store that cannot by reached by any query).

A StoreDiff answers a logical question: “does there exist a query path which can return data from that row?”.

An event of kind deletion only tells you that, from this point on, no query can return data from that row. That doesn’t necessarily mean that the data is actually gone, i.e. don’t make assumptions of e.g. the size in bytes of the store based on these events. They are in “query-model space” and are not an accurate representation of what happens in storage space.

row_id: RowId

What’s the row’s RowId?

RowIds are guaranteed to be unique within a single DataStore.

Put another way, the same RowId can only appear twice in a StoreDiff event: one addition and (optionally) one deletion (in that order!).

times: Vec<(Timeline, TimeInt)>

The time data associated with that row.

Since insertions and deletions both work on a row-level basis, this is guaranteed to be the same value for both the insertion and deletion events (if any).

This is not a TimePoint for performance reasons.

entity_path: EntityPath

The EntityPath associated with that row.

Since insertions and deletions both work on a row-level basis, this is guaranteed to be the same value for both the insertion and deletion events (if any).

cells: HashMap<ComponentName, DataCell, BuildHasherDefault<NoHashHasher<ComponentName>>>

All the DataCells associated with that row.

Since insertions and deletions both work on a row-level basis, this is guaranteed to be the same set of values for both the insertion and deletion events (if any).

Implementations

impl StoreDiff

pub fn addition( row_id: impl Into<RowId>, entity_path: impl Into<EntityPath> ) -> StoreDiff

pub fn deletion( row_id: impl Into<RowId>, entity_path: impl Into<EntityPath> ) -> StoreDiff

pub fn at_timepoint( &mut self, timepoint: impl Into<TimePoint> ) -> &mut StoreDiff

pub fn at_timestamp( &mut self, timeline: impl Into<Timeline>, time: impl Into<TimeInt> ) -> &mut StoreDiff

pub fn with_cells( &mut self, cells: impl IntoIterator<Item = DataCell> ) -> &mut StoreDiff

pub fn timepoint(&self) -> TimePoint

pub fn is_timeless(&self) -> bool

pub fn delta(&self) -> i64

-1 for deletions, +1 for additions.

pub fn num_components(&self) -> usize

Trait Implementations

impl Clone for StoreDiff

fn clone(&self) -> StoreDiff

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StoreDiff

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

Formats the value using the given formatter.

impl PartialEq for StoreDiff

fn eq(&self, other: &StoreDiff) -> 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 StoreDiff