Struct ComponentColumnDescriptor

pub struct ComponentColumnDescriptor {
    pub store_datatype: DataType,
    pub component_name: ComponentName,
    pub entity_path: EntityPath,
    pub archetype_name: Option<ArchetypeName>,
    pub archetype_field_name: Option<ArchetypeFieldName>,
    pub is_static: bool,
    pub is_indicator: bool,
    pub is_tombstone: bool,
    pub is_semantically_empty: bool,
}

Describes a data/component column, such as Position3D, in a dataframe.

This is an [ArrowField] that contains specific meta-data.

Fields

store_datatype: DataType

The Arrow datatype of the stored column.

This is the log-time datatype corresponding to how this data is encoded in a chunk. Currently this will always be an [arrow::array::ListArray], but as we introduce mono-type optimization, this might be a native type instead.

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.

entity_path: EntityPath

The path of the entity.

If this column is part of a chunk batch, this is the same for all columns in the batch, and will also be set in the schema for the whole chunk.

If this is missing from the metadata, it will be set to /.

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.

is_static: bool

Whether this column represents static data.

is_indicator: bool

Whether this column represents an indicator component.

is_tombstone: bool

Whether this column represents a Clear-related components.

is_semantically_empty: bool

Whether this column contains either no data or only contains null and/or empty values ([]).

Implementations

impl ComponentColumnDescriptor

pub fn sanity_check(&self)

Debug-only sanity check.

pub fn component_path(&self) -> ComponentPath

pub fn is_static(&self) -> bool

pub fn matches(&self, entity_path: &EntityPath, component_name: &str) -> bool

fn metadata(&self, batch_type: BatchType) -> ArrowFieldMetadata

pub fn returned_datatype(&self) -> ArrowDatatype

pub fn column_name(&self, batch_type: BatchType) -> String

pub fn to_arrow_field(&self, batch_type: BatchType) -> ArrowField

impl ComponentColumnDescriptor

pub fn from_arrow_field( chunk_entity_path: Option<&EntityPath>, field: &ArrowField, ) -> Self

chunk_entity_path: if this column is part of a chunk batch, what is its entity path (so we can set ComponentColumnDescriptor::entity_path)?

Trait Implementations

impl Clone for ComponentColumnDescriptor

fn clone(&self) -> ComponentColumnDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentColumnDescriptor

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

Formats the value using the given formatter.

impl Display for ComponentColumnDescriptor

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

Formats the value using the given formatter.

impl<'a> From<&'a ComponentColumnDescriptor> for ColumnDescriptorRef<'a>

fn from(desc: &'a ComponentColumnDescriptor) -> Self

Converts to this type from the input type.

impl From<&ComponentColumnDescriptor> for ComponentDescriptor

fn from(descr: &ComponentColumnDescriptor) -> Self

Converts to this type from the input type.

impl From<ComponentColumnDescriptor> for ComponentDescriptor

fn from(descr: ComponentColumnDescriptor) -> Self

Converts to this type from the input type.

impl Hash for ComponentColumnDescriptor

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

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 ComponentColumnDescriptor

fn cmp(&self, other: &Self) -> 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 ComponentColumnDescriptor

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

fn partial_cmp(&self, other: &Self) -> 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 Eq for ComponentColumnDescriptor

impl StructuralPartialEq for ComponentColumnDescriptor