Struct rerun::external::re_chunk_store::ComponentColumnDescriptor

pub struct ComponentColumnDescriptor {
    pub store_datatype: DataType,
    pub entity_path: EntityPath,
    pub archetype_name: Option<ArchetypeName>,
    pub archetype_field_name: Option<ArchetypeFieldName>,
    pub component_name: ComponentName,
    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.

entity_path: EntityPath

The path of the entity.

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.

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 component_path(&self) -> ComponentPath

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

pub fn returned_datatype(&self) -> DataType

pub fn to_arrow_field(&self) -> Field

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<(), Error>

Formats the value using the given formatter.

impl Display for ComponentColumnDescriptor

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 ComponentColumnSelector

fn from(desc: ComponentColumnDescriptor) -> ComponentColumnSelector

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 ComponentColumnDescriptor

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 ComponentColumnDescriptor

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

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

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

type Error = MissingFieldMetadata

The type returned in the event of a conversion error.

fn try_from( field: &Field, ) -> Result<ComponentColumnDescriptor, <ComponentColumnDescriptor as TryFrom<&Field>>::Error>

Performs the conversion.

impl Eq for ComponentColumnDescriptor

impl StructuralPartialEq for ComponentColumnDescriptor