[go: up one dir, main page]

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

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

Example

text_log_integration:

//! Shows integration of Rerun's `TextLog` with the native logging interface.

use rerun::external::log;

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

    // 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");

    rerun::native_viewer::show(storage.take())?;
    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§

source§

impl TextLog

source

pub const NUM_COMPONENTS: usize = 4usize

source§

impl TextLog

source

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

source

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

source

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

Trait Implementations§

source§

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. Read more
source§

fn name() -> ArchetypeName

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

fn indicator() -> MaybeOwnedComponentBatch<'static>

Creates a ComponentBatch out of the associated Self::Indicator component. Read more
source§

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

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

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

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

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

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

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. Read more
source§

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

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

impl AsComponents for TextLog

source§

fn as_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>>

Exposes the object’s contents as a set of ComponentBatchs. Read more
source§

fn num_instances(&self) -> usize

The number of instances in each batch. Read more
source§

fn to_arrow(&self) -> SerializationResult<Vec<(Field, Box<dyn Array>)>>

Serializes all non-null Components of this bundle into Arrow arrays. Read more
source§

impl Clone for TextLog

source§

fn clone(&self) -> TextLog

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for TextLog

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for TextLog

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl Eq for TextLog

source§

impl StructuralEq for TextLog

source§

impl StructuralPartialEq for TextLog

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more