rerun::archetypes::TextLog Struct Reference

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

#include <rerun/archetypes/text_log.hpp>

Public Types
using	IndicatorComponent = components::IndicatorComponent< IndicatorComponentName >
	Indicator component, used to identify the archetype when converting to a list of components.

Public Member Functions
	TextLog (TextLog &&other)=default
	TextLog (rerun::components::Text _text)
TextLog	with_level (rerun::components::TextLogLevel _level) &&
	The verbosity level of the message.
TextLog	with_color (rerun::components::Color _color) &&
	Optional color to use for the log line in the Rerun Viewer.
size_t	num_instances () const
	Returns the number of primary instances of this archetype.

Public Attributes
rerun::components::Text	text
	The body of the message.
std::optional< rerun::components::TextLogLevel >	level
	The verbosity level of the message.
std::optional< rerun::components::Color >	color
	Optional color to use for the log line in the Rerun Viewer.

Static Public Attributes
static constexpr const char	IndicatorComponentName [] = "rerun.components.TextLogIndicator"

Detailed Description

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

Example

text_log_integration:

#include <loguru.hpp>
#include <rerun.hpp>
 
void loguru_to_rerun(void* user_data, const loguru::Message& message) {
    // NOTE: `rerun::RecordingStream` is thread-safe.
    const rerun::RecordingStream* rec = reinterpret_cast<const rerun::RecordingStream*>(user_data);
 
    rerun::TextLogLevel level;
    if (message.verbosity == loguru::Verbosity_FATAL) {
        level = rerun::TextLogLevel::Critical;
    } else if (message.verbosity == loguru::Verbosity_ERROR) {
        level = rerun::TextLogLevel::Error;
    } else if (message.verbosity == loguru::Verbosity_WARNING) {
        level = rerun::TextLogLevel::Warning;
    } else if (message.verbosity == loguru::Verbosity_INFO) {
        level = rerun::TextLogLevel::Info;
    } else if (message.verbosity == loguru::Verbosity_1) {
        level = rerun::TextLogLevel::Debug;
    } else if (message.verbosity == loguru::Verbosity_2) {
        level = rerun::TextLogLevel::Trace;
    } else {
        level = rerun::TextLogLevel(std::to_string(message.verbosity));
    }
 
    rec->log(
        "logs/handler/text_log_integration",
        rerun::TextLog(message.message).with_level(level)
    );
}
 
int main() {
    const auto rec = rerun::RecordingStream("rerun_example_text_log_integration");
    rec.spawn().exit_on_failure();
 
    // Log a text entry directly:
    rec.log(
        "logs",
        rerun::TextLog("this entry has loglevel TRACE").with_level(rerun::TextLogLevel::Trace)
    );
 
    loguru::add_callback(
        "rerun",
        loguru_to_rerun,
        const_cast<void*>(reinterpret_cast<const void*>(&rec)),
        loguru::Verbosity_INFO
    );
 
    LOG_F(INFO, "This INFO log got added through the standard logging interface");
 
    loguru::remove_callback("rerun"); // we need to do this before `rec` goes out of scope
}

Member Function Documentation

with_level()

TextLog rerun::archetypes::TextLog::with_level ( rerun::components::TextLogLevel  _level ) &&

inline

The verbosity level of the message.

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

Member Data Documentation

level

std::optional<rerun::components::TextLogLevel> rerun::archetypes::TextLog::level

The verbosity level of the message.

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

---

The documentation for this struct was generated from the following file:

• rerun/archetypes/text_log.hpp