Struct ComponentDescriptor

pub struct ComponentDescriptor {
    pub archetype: Option<ArchetypeName>,
    pub component: ComponentIdentifier,
    pub component_type: Option<ComponentType>,
}

A ComponentDescriptor fully describes the semantics of a column of data.

Every component at a given entity path is uniquely identified by the component field of the descriptor. The archetype and component_type fields provide additional information about the semantics of the data.

Fields

archetype: Option<ArchetypeName>

Optional name of the Archetype associated with this data.

None if the data wasn’t logged through an archetype.

Example: rerun.archetypes.Points3D.

component: ComponentIdentifier

Uniquely identifies of the component associated with this data.

Example: Points3D:positions.

component_type: Option<ComponentType>

Optional type information for this component.

Can be used to inform applications on how to interpret the data.

Example: rerun.components.Position3D.

Implementations

impl ComponentDescriptor

pub fn sanity_check(&self)

pub fn display_name(&self) -> &str

Short and usually unique, used in UI.

impl ComponentDescriptor

pub fn partial(component: impl Into<ComponentIdentifier>) -> ComponentDescriptor

Creates a new component descriptor that only has the component set.

Both archetype and component_type will be missing.

pub fn with_archetype( self, archetype_name: ArchetypeName, ) -> ComponentDescriptor

Unconditionally sets Self::archetype to the given one.

pub fn with_component_type( self, component_type: ComponentType, ) -> ComponentDescriptor

Unconditionally sets Self::component to the given one.

pub fn or_with_archetype( self, archetype_name: impl Fn() -> ArchetypeName, ) -> ComponentDescriptor

Sets Self::archetype to the given one iff it’s not already set.

pub fn or_with_component_type( self, component_type: impl FnOnce() -> ComponentType, ) -> ComponentDescriptor

Sets Self::component_type to the given one iff it’s not already set.

Trait Implementations

impl Clone for ComponentDescriptor

fn clone(&self) -> ComponentDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComponentDescriptorExt for ComponentDescriptor

fn archetype_field_name(&self) -> &str

Returns the field name of a Rerun-builtin type.

fn with_builtin_archetype(self, archetype: ArchetypeName) -> ComponentDescriptor

Unconditionally sets ComponentDescriptor::archetype to the given one.

fn or_with_builtin_archetype( self, archetype: impl Fn() -> ArchetypeName, ) -> ComponentDescriptor

Sets ComponentDescriptor::archetype to the given one iff it’s not already set.

impl Debug for ComponentDescriptor

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

Formats the value using the given formatter.

impl Display for ComponentDescriptor

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

Formats the value using the given formatter.

impl From<&ComponentColumnDescriptor> for ComponentDescriptor

fn from(descr: &ComponentColumnDescriptor) -> ComponentDescriptor

Converts to this type from the input type.

impl From<ComponentColumnDescriptor> for ComponentDescriptor

fn from(descr: ComponentColumnDescriptor) -> ComponentDescriptor

Converts to this type from the input type.

impl From<Field> for ComponentDescriptor

fn from(field: Field) -> ComponentDescriptor

Converts to this type from the input type.

impl Hash for ComponentDescriptor

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ComponentDescriptor

fn cmp(&self, other: &ComponentDescriptor) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ComponentDescriptor

fn eq(&self, other: &ComponentDescriptor) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ComponentDescriptor

fn partial_cmp(&self, other: &ComponentDescriptor) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl SizeBytes for ComponentDescriptor

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 Eq for ComponentDescriptor

impl IsEnabled for ComponentDescriptor

impl StructuralPartialEq for ComponentDescriptor