Struct rerun::sdk::ComponentDescriptor

pub struct ComponentDescriptor {
    pub archetype_name: Option<ArchetypeName>,
    pub archetype_field_name: Option<ArchetypeFieldName>,
    pub component_name: ComponentName,
}

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

Every component is uniquely identified by its ComponentDescriptor.

Fields

archetype_name: 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.

archetype_field_name: Option<ArchetypeFieldName>

Optional name of the field within Archetype associated with this data.

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

Example: positions.

component_name: ComponentName

Semantic name associated with this data.

This is fully implied by archetype_name and archetype_field, but included for semantic convenience.

Example: rerun.components.Position3D.

Implementations

impl ComponentDescriptor

pub fn full_name(&self) -> String

Returns the fully-qualified name, e.g. rerun.archetypes.Points3D:rerun.components.Position3D#positions.

This is the default Display implementation for ComponentDescriptor.

pub fn short_name(&self) -> String

Returns the unqualified name, e.g. Points3D:Position3D#positions.

impl ComponentDescriptor

pub fn new(component_name: impl Into<ComponentName>) -> ComponentDescriptor

pub fn untagged(self) -> ComponentDescriptor

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

Unconditionally sets Self::archetype_name to the given one.

pub fn with_archetype_field_name( self, archetype_field_name: ArchetypeFieldName, ) -> ComponentDescriptor

Unconditionally sets Self::archetype_field_name to the given one.

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

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

pub fn or_with_archetype_field_name( self, archetype_field_name: impl FnOnce() -> ArchetypeFieldName, ) -> ComponentDescriptor

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

Trait Implementations

impl Clone for ComponentDescriptor

fn clone(&self) -> ComponentDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

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 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ComponentDescriptor

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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 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?

impl Eq for ComponentDescriptor

impl IsEnabled for ComponentDescriptor

impl StructuralPartialEq for ComponentDescriptor