Expand description
The core types and traits 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 Component
s that play well with each other.
Rerun (and the underlying Arrow data framework) is designed to work with large arrays of
Component
s, 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.
Internally, Component
s are implemented using many different Loggable
s.
§Feature flags
serde
— Enable (de)serialization using serde.
Modules§
- archetypes
- Fundamental
Archetype
s that are implemented inre_types_core
directly for convenience and dependency optimization. - arrow_
helpers - arrow_
zip_ validity - Easily iterate over arrow values that may contain nulls.
- components
- Fundamental
Component
s that are implemented inre_types_core
directly for convenience and dependency optimization. - datatypes
- Fundamental datatypes 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 and archetypes.
Macros§
- delegate_
arrow_ tuid - Implements
crate::Component
for any given type that is a simple wrapper (newtype) around aTuid
. - impl_
into_ cow - Implements
From<Self>
andFrom<'a Self>
forCow<Self>
. - static_
assert_ struct_ has_ fields - Useful macro for statically asserting that a
struct
contains some specific fields.
Structs§
- Archetype
Field Name - The name of an
Archetype
’s field, e.g.positions
. - Archetype
Name - The fully-qualified name of an
Archetype
, e.g.rerun.archetypes.Points3D
. - Arrow
String - Convenience-wrapper around an arrow
Buffer
that is known to contain a UTF-8 encoded string. - ChunkId
- A unique ID for a
Chunk
. - Component
Descriptor - A
ComponentDescriptor
fully describes the semantics of a column of data. - Component
Name - The fully-qualified name of a
Component
, e.g.rerun.components.Position2D
. - Datatype
Name - The fully-qualified name of a [
Datatype
], e.g.rerun.datatypes.Vec2D
. - Generic
Indicator Component - A generic indicator component that can be specialized for any
Archetype
. - Named
Indicator Component - An arbitrary named indicator component.
- RowId
- A unique ID for a row’s worth of data within a chunk.
- Serialized
Component Batch - The serialized contents of a
ComponentBatch
with associatedComponentDescriptor
. - Serialized
Component Column - A column’s worth of component data.
- View
Class Identifier - The unique name of a view
Enums§
Constants§
- DEFAULT_
DISPLAY_ DECIMALS - Number of decimals shown for all float display methods.
Traits§
- Archetype
- An archetype is a high-level construct that represents a set of
Component
s that usually play well with each other (i.e. they compose nicely). - Archetype
Reflection Marker - Indicates that the archetype has reflection data available for it.
- AsComponents
- Describes the interface for interpreting an object as a bundle of
Component
s. - Component
- A
Component
describes semantic data that can be used by any number ofArchetype
s. - Component
Batch - A
ComponentBatch
represents an array’s worth ofComponent
instances. - Loggable
- A
Loggable
represents a single instance in an array of loggable data. - Loggable
Batch - A
LoggableBatch
represents an array’s worth ofLoggable
instances, ready to be serialized. - Result
Ext - View
- Views are the panels shown in the viewer’s viewport and the primary means of inspecting & visualizing previously logged data.