Struct re_types::blueprint::archetypes::ViewContents

pub struct ViewContents {
    pub query: Option<SerializedComponentBatch>,
}

Archetype: The contents of a View.

The contents are found by combining a collection of QueryExpressions.

+ /world/**           # add everything…
- /world/roads/**     # …but remove all roads…
+ /world/roads/main   # …but show main road

If there is multiple matching rules, the most specific rule wins. If there are multiple rules of the same specificity, the last one wins. If no rules match, the path is excluded.

Specifying a path without a + or - prefix is equivalent to +:

/world/**           # add everything…
- /world/roads/**   # …but remove all roads…
/world/roads/main   # …but show main road

The /** suffix matches the whole subtree, i.e. self and any child, recursively (/world/** matches both /world and /world/car/driver). Other uses of * are not (yet) supported.

Internally, EntityPathFilter sorts the rule by entity path, with recursive coming before non-recursive. This means the last matching rule is also the most specific one. For instance:

+ /world/**
- /world
- /world/car/**
+ /world/car/driver

The last rule matching /world/car/driver is + /world/car/driver, so it is included. The last rule matching /world/car/hood is - /world/car/**, so it is excluded. The last rule matching /world is - /world, so it is excluded. The last rule matching /world/house is + /world/**, so it is included.

Fields

query: Option<SerializedComponentBatch>

The QueryExpression that populates the contents for the view.

They determine which entities are part of the view.

Implementations

impl ViewContents

pub fn descriptor_query() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::query.

pub fn descriptor_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl ViewContents

pub const NUM_COMPONENTS: usize = 2usize

The total number of components in the archetype: 0 required, 1 recommended, 1 optional

impl ViewContents

pub fn new(query: impl IntoIterator<Item = impl Into<QueryExpression>>) -> Self

Create a new ViewContents.

pub fn update_fields() -> Self

Update only some specific fields of a ViewContents.

pub fn clear_fields() -> Self

Clear all the fields of a ViewContents.

pub fn with_query( self, query: impl IntoIterator<Item = impl Into<QueryExpression>>, ) -> Self

The QueryExpression that populates the contents for the view.

They determine which entities are part of the view.

Trait Implementations

impl Archetype for ViewContents

type Indicator = GenericIndicatorComponent<ViewContents>

The associated indicator component, whose presence indicates that the high-level archetype-based APIs were used to log the data.

fn name() -> ArchetypeName

The fully-qualified name of this archetype, e.g. rerun.archetypes.Points2D.

fn display_name() -> &'static str

Readable name for displaying in UI.

fn indicator() -> SerializedComponentBatch

Creates a ComponentBatch out of the associated Self::Indicator component.

fn required_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must be provided by the user when constructing this archetype.

fn recommended_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that should be provided by the user when constructing this archetype.

fn optional_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that may be provided by the user when constructing this archetype.

fn all_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentDescriptor, ArrayRef)>, ) -> DeserializationResult<Self>

Given an iterator of Arrow arrays and their respective ComponentNames, deserializes them into this archetype.

fn from_arrow( data: impl IntoIterator<Item = (Field, Arc<dyn Array>)>, ) -> Result<Self, DeserializationError>

where Self: Sized,

Given an iterator of Arrow arrays and their respective field metadata, deserializes them into this archetype.

impl AsComponents for ViewContents

fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>

Exposes the object’s contents as a set of SerializedComponentBatches.

fn to_arrow(&self) -> Result<Vec<(Field, Arc<dyn Array>)>, SerializationError>

Serializes all non-null Components of this bundle into Arrow arrays.

impl Clone for ViewContents

fn clone(&self) -> ViewContents

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ViewContents

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

Formats the value using the given formatter.

impl Default for ViewContents

fn default() -> ViewContents

Returns the “default value” for a type.

impl SizeBytes for ViewContents

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

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?

impl ArchetypeReflectionMarker for ViewContents