Trait rerun::sdk::ComponentBatch

pub trait ComponentBatch: LoggableBatch {
    // Required method
    fn descriptor(&self) -> Cow<'_, ComponentDescriptor>;

    // Provided methods
    fn to_arrow_list_array(&self) -> Result<ListArray<i32>, SerializationError> { ... }
    fn with_descriptor(
        &self,
        descriptor: ComponentDescriptor,
    ) -> ComponentBatchCowWithDescriptor<'_>
       where Self: Sized { ... }
    fn name(&self) -> ComponentName { ... }
}

Expand description

A ComponentBatch represents an array’s worth of Component instances.

Required Methods§

fn descriptor(&self) -> Cow<'_, ComponentDescriptor>

Returns the complete ComponentDescriptor for this ComponentBatch.

Every component batch is uniquely identified by its ComponentDescriptor.

Provided Methods§

fn to_arrow_list_array(&self) -> Result<ListArray<i32>, SerializationError>

Serializes the batch into an Arrow list array with a single component per list.

fn with_descriptor( &self, descriptor: ComponentDescriptor, ) -> ComponentBatchCowWithDescriptor<'_>
where Self: Sized,

fn name(&self) -> ComponentName

The fully-qualified name of this component batch, e.g. rerun.components.Position2D.

This is a trivial but useful helper for self.descriptor().component_name.

The default implementation already does the right thing. Do not override unless you know what you’re doing. Self::name() must exactly match the value returned by self.descriptor().component_name, or undefined behavior ensues.

Trait Implementations§

impl AsComponents for dyn ComponentBatch

fn as_component_batches(&self) -> Vec<ComponentBatchCowWithDescriptor<'_>>

Exposes the object’s contents as a set of ComponentBatchs. Read more

fn to_arrow2(&self) -> Result<Vec<(Field, Box<dyn Array>)>, SerializationError>

Serializes all non-null Components of this bundle into Arrow arrays. Read more

impl<'a> From<&'a dyn ComponentBatch> for ComponentBatchCow<'a>

fn from(comp_batch: &'a dyn ComponentBatch) -> ComponentBatchCow<'a>

Converts to this type from the input type.

Implementations on Foreign Types§

impl<C> ComponentBatch for &[C]
where C: Component,

fn descriptor(&self) -> Cow<'_, ComponentDescriptor>

impl<C> ComponentBatch for &[Option<C>]
where C: Component,

fn descriptor(&self) -> Cow<'_, ComponentDescriptor>

impl<C> ComponentBatch for Option<C>
where C: Component,

fn descriptor(&self) -> Cow<'_, ComponentDescriptor>

impl<C> ComponentBatch for Vec<Option<C>>
where C: Component,

fn descriptor(&self) -> Cow<'_, ComponentDescriptor>

impl<C> ComponentBatch for Vec<C>
where C: Component,

fn descriptor(&self) -> Cow<'_, ComponentDescriptor>

impl<C, const N: usize> ComponentBatch for &[C; N]
where C: Component,

fn descriptor(&self) -> Cow<'_, ComponentDescriptor>

impl<C, const N: usize> ComponentBatch for &[Option<C>; N]
where C: Component,

fn descriptor(&self) -> Cow<'_, ComponentDescriptor>

impl<C, const N: usize> ComponentBatch for [C; N]
where C: Component,

fn descriptor(&self) -> Cow<'_, ComponentDescriptor>

impl<C, const N: usize> ComponentBatch for [Option<C>; N]
where C: Component,

fn descriptor(&self) -> Cow<'_, ComponentDescriptor>

Implementors§

impl ComponentBatch for NamedIndicatorComponent

impl<'a> ComponentBatch for ComponentBatchCow<'a>

impl<'a> ComponentBatch for ComponentBatchCowWithDescriptor<'a>

impl<A> ComponentBatch for GenericIndicatorComponent<A>
where A: Archetype,

impl<C> ComponentBatch for C
where C: Component,