Struct re_types::archetypes::TextLog
source · 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: TextThe 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
impl TextLog
pub fn new(text: impl Into<Text>) -> Self
pub fn with_level(self, level: impl Into<TextLogLevel>) -> Self
pub fn with_color(self, color: impl Into<Color>) -> Self
Trait Implementations§
source§impl Archetype for TextLog
impl Archetype for TextLog
§type Indicator = GenericIndicatorComponent<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
fn name() -> ArchetypeName
The fully-qualified name of this archetype, e.g.
rerun.archetypes.Points2D.source§fn indicator() -> MaybeOwnedComponentBatch<'static>
fn indicator() -> MaybeOwnedComponentBatch<'static>
source§fn required_components() -> Cow<'static, [ComponentName]>
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]>
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]>
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]>
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>
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
impl AsComponents for TextLog
source§fn as_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>>
fn as_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>>
Exposes the object’s contents as a set of
ComponentBatchs. Read moresource§fn num_instances(&self) -> usize
fn num_instances(&self) -> usize
The number of instances in each batch. Read more
source§impl PartialEq for TextLog
impl PartialEq for TextLog
impl Eq for TextLog
impl StructuralEq for TextLog
impl StructuralPartialEq for TextLog
Auto Trait Implementations§
impl RefUnwindSafe for TextLog
impl Send for TextLog
impl Sync for TextLog
impl Unpin for TextLog
impl UnwindSafe for TextLog
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more