Struct RecordingInfo 

pub struct RecordingInfo {
    pub start_time: Option<SerializedComponentBatch>,
    pub name: Option<SerializedComponentBatch>,
}

Archetype: A list of properties associated with a recording.

Fields

start_time: Option<SerializedComponentBatch>

When the recording started.

Should be an absolute time, i.e. relative to Unix Epoch.

name: Option<SerializedComponentBatch>

A user-chosen name for the recording.

Implementations

impl RecordingInfo

pub fn descriptor_start_time() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::start_time.

The corresponding component is crate::components::Timestamp.

pub fn descriptor_name() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::name.

The corresponding component is crate::components::Name.

impl RecordingInfo

pub const NUM_COMPONENTS: usize = 2usize

The total number of components in the archetype: 0 required, 0 recommended, 2 optional

impl RecordingInfo

pub fn new() -> RecordingInfo

Create a new RecordingInfo.

pub fn update_fields() -> RecordingInfo

Update only some specific fields of a RecordingInfo.

pub fn clear_fields() -> RecordingInfo

Clear all the fields of a RecordingInfo.

pub fn columns<I>( self, _lengths: I, ) -> Result<impl Iterator<Item = SerializedComponentColumn>, SerializationError>

where I: IntoIterator<Item = usize> + Clone,

Partitions the component data into multiple sub-batches.

Specifically, this transforms the existing SerializedComponentBatches data into SerializedComponentColumns instead, via SerializedComponentBatch::partitioned.

This makes it possible to use RecordingStream::send_columns to send columnar data directly into Rerun.

The specified lengths must sum to the total length of the component batch.

pub fn columns_of_unit_batches( self, ) -> Result<impl Iterator<Item = SerializedComponentColumn>, SerializationError>

Helper to partition the component data into unit-length sub-batches.

This is semantically similar to calling Self::columns with std::iter::take(1).repeat(n), where n is automatically guessed.

pub fn with_start_time(self, start_time: impl Into<Timestamp>) -> RecordingInfo

When the recording started.

Should be an absolute time, i.e. relative to Unix Epoch.

pub fn with_many_start_time( self, start_time: impl IntoIterator<Item = impl Into<Timestamp>>, ) -> RecordingInfo

This method makes it possible to pack multiple crate::components::Timestamp in a single component batch.

This only makes sense when used in conjunction with Self::columns. Self::with_start_time should be used when logging a single row’s worth of data.

pub fn with_name(self, name: impl Into<Name>) -> RecordingInfo

A user-chosen name for the recording.

pub fn with_many_name( self, name: impl IntoIterator<Item = impl Into<Name>>, ) -> RecordingInfo

This method makes it possible to pack multiple crate::components::Name in a single component batch.

This only makes sense when used in conjunction with Self::columns. Self::with_name should be used when logging a single row’s worth of data.

Trait Implementations

impl Archetype for RecordingInfo

fn name() -> ArchetypeName

The fully-qualified name of this archetype, e.g. rerun.archetypes.Points2D.

fn display_name() -> &'static str

Readable name for displaying in UI.

fn required_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must be provided by the user when constructing this archetype.

fn recommended_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that should be provided by the user when constructing this archetype.

fn optional_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that may be provided by the user when constructing this archetype.

fn all_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentDescriptor, Arc<dyn Array>)>, ) -> Result<RecordingInfo, DeserializationError>

Given an iterator of Arrow arrays and their respective ComponentDescriptors, deserializes them into this archetype.

fn from_arrow( data: impl IntoIterator<Item = (Field, Arc<dyn Array>)>, ) -> Result<Self, DeserializationError>

where Self: Sized,

Given an iterator of Arrow arrays and their respective field metadata, deserializes them into this archetype.

impl AsComponents for RecordingInfo

fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>

Exposes the object’s contents as a set of SerializedComponentBatches.

fn to_arrow(&self) -> Result<Vec<(Field, Arc<dyn Array>)>, SerializationError>

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

impl Clone for RecordingInfo

fn clone(&self) -> RecordingInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecordingInfo

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

Formats the value using the given formatter.

impl Default for RecordingInfo

fn default() -> RecordingInfo

Returns the “default value” for a type.

impl SizeBytes for RecordingInfo

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

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.

fn is_pod() -> bool

Is Self just plain old data?

impl ArchetypeReflectionMarker for RecordingInfo