Struct rerun::TextLog

pub struct TextLog {
    pub text: Option<SerializedComponentBatch>,
    pub level: Option<SerializedComponentBatch>,
    pub color: Option<SerializedComponentBatch>,
}

Archetype: A log entry in a text log, comprised of a text body and its log level.

Example

text_log_integration:

use rerun::external::log;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let rec = rerun::RecordingStreamBuilder::new("rerun_example_text_log_integration").spawn()?;

    // Log a text entry directly:
    rec.log(
        "logs",
        &rerun::TextLog::new("this entry has loglevel TRACE")
            .with_level(rerun::TextLogLevel::TRACE),
    )?;

    // Or log via a logging handler:
    rerun::Logger::new(rec.clone()) // recording streams are ref-counted
        .with_path_prefix("logs/handler")
        // You can also use the standard `RUST_LOG` environment variable!
        .with_filter(rerun::default_log_filter())
        .init()?;
    log::info!("This INFO log got added through the standard logging interface");

    log::logger().flush();

    Ok(())
}

Fields

text: Option<SerializedComponentBatch>

The body of the message.

level: Option<SerializedComponentBatch>

The verbosity level of the message.

This can be used to filter the log messages in the Rerun Viewer.

color: Option<SerializedComponentBatch>

Optional color to use for the log line in the Rerun Viewer.

Implementations

impl TextLog

pub fn descriptor_text() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::text.

pub fn descriptor_level() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::level.

pub fn descriptor_color() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::color.

pub fn descriptor_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl TextLog

pub const NUM_COMPONENTS: usize = 4usize

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

impl TextLog

pub fn new(text: impl Into<Text>) -> TextLog

Create a new TextLog.

pub fn update_fields() -> TextLog

Update only some specific fields of a TextLog.

pub fn clear_fields() -> TextLog

Clear all the fields of a TextLog.

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_text(self, text: impl Into<Text>) -> TextLog

The body of the message.

pub fn with_many_text( self, text: impl IntoIterator<Item = impl Into<Text>>, ) -> TextLog

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

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

pub fn with_level(self, level: impl Into<TextLogLevel>) -> TextLog

The verbosity level of the message.

This can be used to filter the log messages in the Rerun Viewer.

pub fn with_many_level( self, level: impl IntoIterator<Item = impl Into<TextLogLevel>>, ) -> TextLog

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

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

pub fn with_color(self, color: impl Into<Color>) -> TextLog

Optional color to use for the log line in the Rerun Viewer.

pub fn with_many_color( self, color: impl IntoIterator<Item = impl Into<Color>>, ) -> TextLog

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

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

Trait Implementations

impl Archetype for TextLog

type Indicator = GenericIndicatorComponent<TextLog>

The associated indicator component, whose presence indicates that the high-level archetype-based APIs were used to log the data.

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 indicator() -> SerializedComponentBatch

Creates a ComponentBatch out of the associated Self::Indicator component.

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<TextLog, DeserializationError>

Given an iterator of Arrow arrays and their respective ComponentNames, 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 TextLog

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 TextLog

fn clone(&self) -> TextLog

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextLog

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

Formats the value using the given formatter.

impl Default for TextLog

fn default() -> TextLog

Returns the “default value” for a type.

impl PartialEq for TextLog

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

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 TextLog

impl StructuralPartialEq for TextLog