Struct McapMessage 

pub struct McapMessage {
    pub data: Option<SerializedComponentBatch>,
}

Archetype: The binary payload of a single MCAP message, without metadata.

This archetype represents only the raw message data from an MCAP file. It does not include MCAP message metadata such as timestamps, channel IDs, sequence numbers, or publication times. The binary payload represents sensor data, commands, or other information encoded according to the format specified by the associated channel.

See archetypes::McapChannel for channel definitions that specify message encoding, archetypes::McapSchema for data structure definitions, and the MCAP specification for complete format details.

⚠️ This type is unstable and may change significantly in a way that the data won’t be backwards compatible.

Fields

data: Option<SerializedComponentBatch>

The raw message payload as a binary blob.

This contains the actual message data encoded according to the format specified by the associated channel’s message_encoding field. The structure and interpretation of this binary data depends on the encoding format (e.g., ros1, cdr, protobuf) and the message schema defined for the channel.

Implementations

impl McapMessage

pub fn descriptor_data() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::data.

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

impl McapMessage

pub const NUM_COMPONENTS: usize = 1usize

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

impl McapMessage

pub fn new(data: impl Into<Blob>) -> McapMessage

Create a new McapMessage.

pub fn update_fields() -> McapMessage

Update only some specific fields of a McapMessage.

pub fn clear_fields() -> McapMessage

Clear all the fields of a McapMessage.

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_data(self, data: impl Into<Blob>) -> McapMessage

The raw message payload as a binary blob.

This contains the actual message data encoded according to the format specified by the associated channel’s message_encoding field. The structure and interpretation of this binary data depends on the encoding format (e.g., ros1, cdr, protobuf) and the message schema defined for the channel.

pub fn with_many_data( self, data: impl IntoIterator<Item = impl Into<Blob>>, ) -> McapMessage

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

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

Trait Implementations

impl Archetype for McapMessage

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<McapMessage, 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 McapMessage

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 McapMessage

fn clone(&self) -> McapMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for McapMessage

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

Formats the value using the given formatter.

impl Default for McapMessage

fn default() -> McapMessage

Returns the “default value” for a type.

impl PartialEq for McapMessage

fn eq(&self, other: &McapMessage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SizeBytes for McapMessage

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 McapMessage

impl StructuralPartialEq for McapMessage