Crate re_types_core 

The core traits and types that power Rerun’s data model.

The Archetype trait is the core of this crate and is a good starting point to get familiar with the code. An archetype is a logical collection of batches of Components that play well with each other.

Rerun (and the underlying Arrow data framework) is designed to work with large arrays of Components, as opposed to single instances. When multiple instances of a Component are put together in an array, they yield a ComponentBatch: the atomic unit of (de)serialization.

Conversion to and from Arrow is split across five traits, so that each type only implements the conversions that make sense for it: ArrowDataType, ToArrow, ToArrowOpt, FromArrow and FromArrowOpt. A Component requires ToArrow and FromArrow; the nullable variants are optional and being phased out.

Feature flags

No documented features in Cargo.toml

Re-exports

pub use self::encodings as datatypes;

Modules

archetypes

Fundamental Archetypes that are implemented in re_types_core directly for convenience and dependency optimization.

arrow_helpers

arrow_zip_validity

Easily iterate over arrow values that may contain nulls.

components

Fundamental Components that are implemented in re_types_core directly for convenience and dependency optimization.

encodings

Fundamental encodings that are implemented in re_types_core directly for convenience and dependency optimization.

external

macros

reflection

Run-time reflection for reading meta-data about components, archetypes, and views.

Macros

delegate_arrow_tuid

Implements crate::Component for any given type that is a simple wrapper (newtype) around a Tuid.

impl_from_arrow_opt_via_from_arrow

Implements FromArrowOpt in terms of FromArrow.

impl_from_arrow_via_from_arrow_opt

Implements FromArrow in terms of FromArrowOpt.

impl_into_cow

Implements From<Self> and From<'a Self> for Cow<Self>.

impl_to_arrow_via_to_arrow_opt

Implements ToArrow in terms of ToArrowOpt.

static_assert_struct_has_fields

Useful macro for statically asserting that a struct contains some specific fields.

Structs

ArchetypeName

The fully-qualified name of an Archetype, e.g. rerun.archetypes.Points3D.

ArrowString

Convenience-wrapper around an arrow Buffer that is known to contain a UTF-8 encoded string.

ChunkId

A unique ID for a Chunk.

ComponentDescriptor

A ComponentDescriptor fully describes the semantics of a column of data.

ComponentIdentifier

Uniquely identifies a component (a field of data) within an entity.

ComponentType

The fully-qualified name of a Component, e.g. rerun.components.Position2D.

DynamicArchetype

A helper for logging a dynamically defined archetype to Rerun.

InvalidComponentIdentifierError

Error returned when constructing an invalid ComponentIdentifier.

InvalidLayerNameError

Error returned when constructing an invalid LayerName.

InvalidTimelineNameError

Error returned when constructing an invalid TimelineName.

LayerName

The name of a layer (e.g. "base").

RowId

A unique ID for a row’s worth of data within a chunk.

SegmentId

Identifies a single segment within a dataset.

SerializedComponentBatch

The serialized contents of a ComponentBatch with associated ComponentDescriptor.

SerializedComponentColumn

A column’s worth of component data.

TimelineName

The name of a timeline. Often something like "log_time" or "frame_nr".

ViewClassIdentifier

The unique name of a view

Enums

DeserializationError

SerializationError

Constants

DEFAULT_DISPLAY_DECIMALS

Number of decimals shown for all float display methods.

FIELD_METADATA_KEY_ARCHETYPE

The key used to identify the crate::ArchetypeName in field-level metadata.

FIELD_METADATA_KEY_COMPONENT

The key used to identify the crate::ComponentIdentifier in field-level metadata.

FIELD_METADATA_KEY_COMPONENT_TYPE

The key used to identify the crate::ComponentType in field-level metadata.

Traits

Archetype

An archetype is a high-level construct that represents a set of Components that usually play well with each other (i.e. they compose nicely).

ArchetypeReflectionMarker

Indicates that the archetype has reflection data available for it.

ArrowDataType

Describes the Arrow datatype that a type is (de)serialized to and from.

AsComponents

Describes the interface for interpreting an object as a bundle of Components.

Component

A Component describes semantic data that can be used by any number of Archetypes.

ComponentBatch

A ComponentBatch represents an array’s worth of loggable instances, ready to be serialized.

FromArrow

Deserializes an Arrow array into a collection of values, failing on nulls.

FromArrowOpt

Deserializes a nullable Arrow array into a collection of optional values.

ResultExt

ToArrow

Serializes an iterator of values into an Arrow array.

ToArrowOpt

Serializes an iterator of optional values into a nullable Arrow array.

View

Views are the panels shown in the viewer’s viewport and the primary means of inspecting & visualizing previously logged data.

WrapperComponent

Implementation helper for Components that wrap a single encoding.

Functions

from_arrow_opt_via_from_arrow

Implements FromArrowOpt::from_arrow_opt in terms of FromArrow.

from_arrow_via_from_arrow_opt

Implements FromArrow::from_arrow in terms of FromArrowOpt, failing on nulls.

to_arrow_via_to_arrow_opt

Implements ToArrow::to_arrow in terms of ToArrowOpt.

tuids_to_arrow

Type Aliases

ComponentSet

DeserializationResult

SerializationResult

UnorderedComponentSet

_Backtrace