Struct rerun::StoreEvent

pub struct StoreEvent {
    pub store_id: StoreId,
    pub store_generation: StoreGeneration,
    pub event_id: u64,
    pub diff: StoreDiff,
}

Everything needed to build custom StoreSubscribers. The atomic unit of change in the Rerun DataStore.

A StoreEvent describes the changes caused by the addition or deletion of a re_log_types::DataRow in the store.

Methods that mutate the DataStore, such as DataStore::insert_row and DataStore::gc, return StoreEvents that describe the changes. You can also register your own StoreSubscriber in order to be notified of changes as soon as they happen.

Refer to field-level documentation for more details and check out StoreDiff for a precise definition of what an event involves.

Fields

store_id: StoreId

Which DataStore sent this event?

store_generation: StoreGeneration

What was the store’s generation when it sent that event?

event_id: u64

Monotonically increasing ID of the event.

This is on a per-store basis.

When handling a StoreEvent, if this is the first time you process this StoreId and the associated event_id is not 1, it means you registered late and missed some updates.

diff: StoreDiff

What actually changed?

Refer to StoreDiff for more information.

Methods from Deref<Target = 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 StoreEvent

fn clone(&self) -> StoreEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StoreEvent

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

Formats the value using the given formatter.

impl Deref for StoreEvent

type Target = StoreDiff

The resulting type after dereferencing.

fn deref(&self) -> &<StoreEvent as Deref>::Target

Dereferences the value.

impl PartialEq for StoreEvent

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