Struct SorbetColumnDescriptors

pub struct SorbetColumnDescriptors {
    pub row_id: Option<RowIdColumnDescriptor>,
    pub indices: Vec<IndexColumnDescriptor>,
    pub components: Vec<ComponentColumnDescriptor>,
}

Fields

row_id: Option<RowIdColumnDescriptor>

The primary row id column. If present, it is always the first column.

indices: Vec<IndexColumnDescriptor>

Index columns (timelines).

components: Vec<ComponentColumnDescriptor>

The actual component data

Implementations

impl SorbetColumnDescriptors

pub fn sanity_check(&self)

Debug-only sanity check.

pub fn num_columns(&self) -> usize

Total number of columns in this chunk, including the row id column, the index columns, and the data columns.

pub fn entity_paths(&self) -> IntSet<EntityPath>

All unique entity paths present in the view contents.

pub fn descriptors(&self) -> impl Iterator<Item = ColumnDescriptorRef<'_>> + '_

Returns all columns, including the row_id column.

See also Self::indices_and_components.

pub fn indices_and_components(&self) -> Vec<ColumnDescriptor>

Returns all indices and then all components; skipping the row_id column.

See also Self::get_index_or_component.

pub fn get_index_or_component( &self, index_ignoring_row_id: usize, ) -> Option<ColumnDescriptor>

Index the index- and component columns, ignoring the row_id column completely.

That is, get_index_or_component(0) will return the first index column (if any; otherwise the first component column).

See also Self::indices_and_components.

pub fn resolve_selector( &self, column_selector: &ColumnSelector, ) -> Result<ColumnDescriptorRef<'_>, ColumnSelectorResolveError>

Resolve the provided column selector. Returns None if no corresponding column was found.

pub fn resolve_index_column_selector( &self, index_column_selector: &TimeColumnSelector, ) -> Result<&IndexColumnDescriptor, ColumnSelectorResolveError>

Resolve the provided index column selector. Returns None if no corresponding column was found.

pub fn resolve_component_column_selector( &self, component_column_selector: &ComponentColumnSelector, ) -> Result<&ComponentColumnDescriptor, ColumnSelectorResolveError>

Resolve the provided component column selector. Returns None if no corresponding column was found.

Matching strategy:

• The entity path must match exactly.
• The first component with a fully matching name is returned (there shouldn’t be more than one for now).
• If no exact match is found, a partial match is attempted using re_types_core::ComponentName::matches and is returned only if it is unique.

pub fn arrow_fields(&self, batch_type: BatchType) -> Vec<ArrowField>

pub fn filter_components( self, keep: impl Fn(&ComponentColumnDescriptor) -> bool, ) -> Self

Keep only the component columns that satisfy the given predicate.

impl SorbetColumnDescriptors

pub fn try_from_arrow_fields( chunk_entity_path: Option<&EntityPath>, fields: &ArrowFields, ) -> Result<Self, SorbetError>

pub fn try_from_arrow_fields_forgiving( chunk_entity_path: Option<&EntityPath>, fields: &ArrowFields, ) -> Result<Self, SorbetError>

Trait Implementations

impl Clone for SorbetColumnDescriptors

fn clone(&self) -> SorbetColumnDescriptors

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SorbetColumnDescriptors

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

Formats the value using the given formatter.

impl From<SorbetSchema> for SorbetColumnDescriptors

fn from(sorbet_schema: SorbetSchema) -> Self

Converts to this type from the input type.

impl PartialEq for SorbetColumnDescriptors

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

impl StructuralPartialEq for SorbetColumnDescriptors