Struct rerun::components::AnnotationContext

pub struct AnnotationContext(pub Vec<ClassDescriptionMapElem>);

Component: The AnnotationContext provides additional information on how to display entities.

Entities can use ClassIds and KeypointIds to provide annotations, and the labels and colors will be looked up in the appropriate AnnotationContext. We use the first annotation context we find in the path-hierarchy when searching up through the ancestors of a given entity path.

Tuple Fields

0: Vec<ClassDescriptionMapElem>

List of class descriptions, mapping class indices to class names, colors etc.

Trait Implementations

impl Clone for AnnotationContext

fn clone(&self) -> AnnotationContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnnotationContext

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

Formats the value using the given formatter.

impl Default for AnnotationContext

fn default() -> AnnotationContext

Returns the “default value” for a type.

impl<I, T> From<T> for AnnotationContext

where I: Into<ClassDescriptionMapElem>, T: IntoIterator<Item = I>,

fn from(v: T) -> AnnotationContext

Converts to this type from the input type.

impl Loggable for AnnotationContext

type Name = ComponentName

fn name() -> <AnnotationContext as Loggable>::Name

The fully-qualified name of this loggable, e.g. rerun.datatypes.Vec2D.

fn arrow_datatype() -> DataType

The underlying arrow2::datatypes::DataType, excluding datatype extensions.

fn to_arrow_opt<'a>( data: impl IntoIterator<Item = Option<impl Into<Cow<'a, AnnotationContext>>>> ) -> Result<Box<dyn Array>, SerializationError>

where AnnotationContext: Clone + 'a,

Given an iterator of options of owned or reference values to the current Loggable, serializes them into an Arrow array. The Arrow array’s datatype will match Loggable::arrow_field.

fn from_arrow_opt( arrow_data: &(dyn Array + 'static) ) -> Result<Vec<Option<AnnotationContext>>, DeserializationError>

where AnnotationContext: Sized,

Given an Arrow array, deserializes it into a collection of optional Loggables.

fn extended_arrow_datatype() -> DataType

The underlying arrow2::datatypes::DataType, including datatype extensions.

fn arrow_field() -> Field

The underlying arrow2::datatypes::Field, including datatype extensions.

fn to_arrow<'a>( data: impl IntoIterator<Item = impl Into<Cow<'a, Self>>> ) -> Result<Box<dyn Array>, SerializationError>

where Self: 'a,

Given an iterator of owned or reference values to the current Loggable, serializes them into an Arrow array. The Arrow array’s datatype will match Loggable::arrow_field.

fn from_arrow( data: &(dyn Array + 'static) ) -> Result<Vec<Self>, DeserializationError>

Given an Arrow array, deserializes it into a collection of Loggables.

impl PartialEq for AnnotationContext

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

fn heap_size_bytes(&self) -> u64

Returns the total size of self on the heap, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

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.

impl Eq for AnnotationContext

impl StructuralPartialEq for AnnotationContext