Struct TextLog

pub struct TextLog {
    pub text: Text,
    pub level: Option<TextLogLevel>,
    pub color: Option<Color>,
}

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: Text

The body of the message.

level: Option<TextLogLevel>

The verbosity level of the message.

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

color: Option<Color>

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

Implementations

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>) -> Self

Create a new TextLog.

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

The verbosity level of the message.

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

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

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

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() -> MaybeOwnedComponentBatch<'static>

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

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

Returns the names of all components that must be provided by the user when constructing this archetype.

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

Returns the names of all components that should be provided by the user when constructing this archetype.

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

Returns the names of all components that may be provided by the user when constructing this archetype.

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

Returns the names of all components that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentName, Box<dyn Array>)>, ) -> DeserializationResult<Self>

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

fn from_arrow( data: impl IntoIterator<Item = (Field, Box<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_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>>

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

fn to_arrow(&self) -> Result<Vec<(Field, Box<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

Formats the value using the given formatter.

impl PartialEq for TextLog

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

fn heap_size_bytes(&self) -> u64

Returns the total size of self on the heap, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

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.

impl ArchetypeReflectionMarker for TextLog

impl Eq for TextLog

impl StructuralPartialEq for TextLog