Struct re_entity_db::entity_db::EntityDb

pub struct EntityDb {
    pub data_source: Option<SmartChannelSource>,
    /* private fields */
}

An in-memory database built from a stream of LogMsges.

NOTE: all mutation is to be done via public functions!

Fields

data_source: Option<SmartChannelSource>

Set by whomever created this EntityDb.

Clones of an EntityDb gets a None source.

Implementations

impl EntityDb

pub fn new(store_id: StoreId) -> Self

pub fn from_info_and_rows( store_info: StoreInfo, rows: impl IntoIterator<Item = DataRow> ) -> Result<Self, Error>

Helper function to create a recording from a StoreInfo and some DataRows.

This is useful to programmatically create recordings from within the viewer, which cannot use the re_sdk, which is not Wasm-compatible.

pub fn tree(&self) -> &EntityTree

pub fn data_store(&self) -> &DataStore

pub fn store_info_msg(&self) -> Option<&SetStoreInfo>

pub fn store_info(&self) -> Option<&StoreInfo>

pub fn app_id(&self) -> Option<&ApplicationId>

pub fn query_caches(&self) -> &Caches

pub fn resolver(&self) -> &PromiseResolver

pub fn latest_at_archetype<A: Archetype>( &self, entity_path: &EntityPath, query: &LatestAtQuery ) -> PromiseResult<Option<((TimeInt, RowId), A)>>

where LatestAtResults: ToArchetype<A>,

Returns Ok(None) if any of the required components are missing.

pub fn latest_at_component<C: Component>( &self, entity_path: &EntityPath, query: &LatestAtQuery ) -> Option<LatestAtMonoResult<C>>

Get the latest index and value for a given dense re_types_core::Component.

This assumes that the row we get from the store contains at most one instance for this component; it will log a warning otherwise.

This should only be used for “mono-components” such as Transform and Tensor.

This is a best-effort helper, it will merely log errors on failure.

pub fn latest_at_component_quiet<C: Component>( &self, entity_path: &EntityPath, query: &LatestAtQuery ) -> Option<LatestAtMonoResult<C>>

Get the latest index and value for a given dense re_types_core::Component.

This assumes that the row we get from the store contains at most one instance for this component; it will log a warning otherwise.

This should only be used for “mono-components” such as Transform and Tensor.

This is a best-effort helper, and will quietly swallow any errors.

pub fn latest_at_component_at_closest_ancestor<C: Component>( &self, entity_path: &EntityPath, query: &LatestAtQuery ) -> Option<(EntityPath, LatestAtMonoResult<C>)>

pub fn store(&self) -> &DataStore

pub fn store_kind(&self) -> StoreKind

pub fn store_id(&self) -> &StoreId

pub fn cloned_from(&self) -> Option<&StoreId>

If this entity db is the result of a clone, which store was it cloned from?

A cloned store always gets a new unique ID.

We currently only use entity db cloning for blueprints: when we activate a default blueprint that was received on the wire (e.g. from a recording), we clone it and make the clone the active blueprint. This means all active blueprints are clones.

pub fn timelines(&self) -> impl ExactSizeIterator<Item = &Timeline>

pub fn times_per_timeline(&self) -> &TimesPerTimeline

pub fn time_histogram(&self, timeline: &Timeline) -> Option<&TimeHistogram>

Histogram of all events on the timeeline, of all entities.

pub fn num_static_messages(&self) -> u64

Total number of static messages for any entity.

pub fn is_component_static( &self, component_path: &ComponentPath ) -> Option<bool>

Returns whether a component is static.

pub fn num_rows(&self) -> usize

pub fn generation(&self) -> StoreGeneration

Return the current StoreGeneration. This can be used to determine whether the database has been modified since the last time it was queried.

pub fn last_modified_at(&self) -> Instant

pub fn latest_row_id(&self) -> Option<RowId>

The highest RowId in the store, which corresponds to the last edit time. Ignores deletions.

pub fn is_empty(&self) -> bool

pub fn entity_paths(&self) -> Vec<&EntityPath>

A sorted list of all the entity paths in this database.

pub fn ingestion_stats(&self) -> &IngestionStatistics

pub fn entity_path_from_hash( &self, entity_path_hash: &EntityPathHash ) -> Option<&EntityPath>

pub fn is_known_entity(&self, entity_path: &EntityPath) -> bool

Returns true also for entities higher up in the hierarchy.

pub fn is_logged_entity(&self, entity_path: &EntityPath) -> bool

If you log world/points, then that is a logged entity, but world is not, unless you log something to world too.

pub fn add(&mut self, msg: &LogMsg) -> Result<(), Error>

pub fn add_data_table(&mut self, table: DataTable) -> Result<(), Error>

pub fn add_data_row(&mut self, row: DataRow) -> Result<(), Error>

Inserts a DataRow into the database.

Updates the crate::EntityTree and applies ClearCascades as needed.

pub fn set_store_info(&mut self, store_info: SetStoreInfo)

pub fn gc_everything_but_the_latest_row(&mut self)

pub fn purge_fraction_of_ram(&mut self, fraction_to_purge: f32)

Free up some RAM by forgetting the older parts of all timelines.

pub fn gc(&mut self, gc_options: &GarbageCollectionOptions)

pub fn sort_key(&self) -> impl Ord + '_

Key used for sorting recordings in the UI.

pub fn to_messages( &self, time_selection: Option<(Timeline, ResolvedTimeRangeF)> ) -> DataTableResult<Vec<LogMsg>>

Export the contents of the current database to a sequence of messages.

If time_selection is specified, then only data for that specific timeline over that specific time range will be accounted for.

pub fn clone_with_new_id(&self, new_id: StoreId) -> Result<EntityDb, Error>

Make a clone of this EntityDb, assigning it a new StoreId.

Trait Implementations

impl SizeBytes for EntityDb

fn heap_size_bytes(&self) -> u64

Returns the total size of self on the heap, in bytes.

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

fn is_pod() -> bool

Is Self just plain old data?