Struct rerun::external::re_viewer_context::external::re_query::ArchetypeView

pub struct ArchetypeView<A>
where
    A: Archetype,
{ /* private fields */ }

A view of an Archetype at a particular point in time returned by crate::get_component_with_instances.

The required Components of an ArchetypeView determines the length of an entity batch. When iterating over individual components, they will be implicitly joined onto the required Components using InstanceKey values.

Implementations

impl<A> ArchetypeView<A>

where A: Archetype,

pub fn num_instances(&self) -> usize

pub fn data_time(&self) -> Option<TimeInt>

The data time of the most recent component in the view (not necessarily the primary!).

None if timeless.

pub fn primary_row_id(&self) -> RowId

Returns the RowId associated with the primary component that was used to drive this entire query.

Beware: when using this RowId for caching/versioning purposes, make sure the component you are about to cache is in fact the primary component of the query! See also https://github.com/rerun-io/rerun/issues/3232.

impl<A> ArchetypeView<A>

where A: Archetype,

pub fn iter_instance_keys(&self) -> impl ExactSizeIterator

Returns an iterator over InstanceKeys.

pub fn has_component<C>(&self) -> bool

where C: Component,

Check if the entity has a component and its not empty

pub fn iter_required_component<'a, C>( &'a self ) -> Result<impl ExactSizeIterator + 'a, DeserializationError>

where C: Component + 'a,

Iterate over the values of a required multi-component.

pub fn required_mono_component<C>(&self) -> Result<C, DeserializationError>

where C: Component,

Get a single required mono-component.

pub fn iter_optional_component<'a, C>( &'a self ) -> Result<impl ExactSizeIterator + 'a, DeserializationError>

where C: Component + Clone + 'a,

Iterate over optional values as native Components.

Always produces an iterator that matches the length of a primary component by joining on the InstanceKey values.

pub fn optional_mono_component<C>( &self ) -> Result<Option<C>, DeserializationError>

where C: Component,

Get a single optional mono-component.

pub fn iter_raw_optional_component<'a, C>( &'a self ) -> Result<Option<impl Iterator<Item = C> + 'a>, DeserializationError>

where C: Component + Clone + 'a,

Iterate over optional values as native Components.

The contents of the cell are returned as-is, without joining with any other component.

pub fn raw_optional_mono_component<C>( &self ) -> Result<Option<C>, DeserializationError>

where C: Component,

Get a single optional mono-component.

pub fn from_components( data_time: Option<TimeInt>, primary_row_id: RowId, components: impl IntoIterator<Item = ComponentWithInstances> ) -> ArchetypeView<A>

Helper function to produce an ArchetypeView from a collection of ComponentWithInstances.

pub fn to_archetype(&self) -> Result<A, QueryError>

Convert an ArchetypeView back into a native Archetype instance

pub fn to_data_cell_row_1<'a, C1>(&self) -> Result<DataCellRow, QueryError>

where C1: Component + Clone + Into<Cow<'a, C1>> + 'a,

Useful for tests.

pub fn to_data_cell_row_2<'a, C1, C2>(&self) -> Result<DataCellRow, QueryError>

where C1: Component + Clone + Into<Cow<'a, C1>> + 'a, C2: Component + Clone + Into<Cow<'a, C2>> + 'a,

Useful for tests.

Trait Implementations

impl<A> Clone for ArchetypeView<A>

where A: Clone + Archetype,

fn clone(&self) -> ArchetypeView<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A> Debug for ArchetypeView<A>

where A: Debug + Archetype,

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

Formats the value using the given formatter.

impl<A> Display for ArchetypeView<A>

where A: Archetype,

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

Formats the value using the given formatter.