Struct re_chunk_store::ChunkStoreEvent

pub struct ChunkStoreEvent {
    pub store_id: StoreId,
    pub store_generation: ChunkStoreGeneration,
    pub event_id: u64,
    pub diff: ChunkStoreDiff,
}

The atomic unit of change in the Rerun ChunkStore.

A ChunkStoreEvent describes the changes caused by the addition or deletion of a [Chunk] in the store.

Methods that mutate the ChunkStore, such as ChunkStore::insert_chunk and ChunkStore::gc, return ChunkStoreEvents that describe the changes. You can also register your own ChunkStoreSubscriber in order to be notified of changes as soon as they happen.

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

Fields

store_id: StoreId

Which ChunkStore sent this event?

store_generation: ChunkStoreGeneration

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 ChunkStoreEvent, 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: ChunkStoreDiff

What actually changed?

Refer to ChunkStoreDiff for more information.

Methods from Deref<Target = ChunkStoreDiff>

pub fn is_static(&self) -> bool

pub fn delta(&self) -> i64

-1 for deletions, +1 for additions.

pub fn num_components(&self) -> usize

Trait Implementations

impl Clone for ChunkStoreEvent

fn clone(&self) -> ChunkStoreEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChunkStoreEvent

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

Formats the value using the given formatter.

impl Deref for ChunkStoreEvent

type Target = ChunkStoreDiff

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl PartialEq for ChunkStoreEvent

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

impl StructuralPartialEq for ChunkStoreEvent