Struct Logger

pub struct Logger { /* private fields */ }

Logger can be passed in as the first argument into one of the logging macros provided by rclrs. When passing it into one of the logging macros, you can optionally apply any of the methods from ToLogParams to tweak the logging behavior.

You can obtain a Logger in the following ways:

• Calling Node::logger to get the logger of a Node
• Using Logger::create_child to create a child logger for an existing logger
• Using Logger::new to create a new logger with any name that you’d like
• Using Logger::default() to access the global default logger

Note that if you are passing the Logger of a Node into one of the logging macros, then you can choose to simply pass in &node instead of node.logger().

Implementations

impl Logger

pub fn new(name: impl Borrow<str>) -> Result<Logger, RclrsError>

Create a new logger with the given name.

pub fn create_child( &self, child_name: impl Borrow<str>, ) -> Result<Logger, RclrsError>

Create a new logger which will be a child of this logger.

If the name of this logger is parent_name, then the name for the new child will be ’“parent_name.child_name”`.

If this is the default logger (whose name is an empty string), then the name for the new child will simply be the value in child_name.

pub fn name(&self) -> &str

Get the name of this logger

pub fn set_level(&self, severity: LogSeverity) -> Result<(), RclrsError>

Set the severity level of this logger

pub fn set_default_level(severity: LogSeverity)

Set the severity level of the default logger which acts as the root ancestor of all other loggers.

Trait Implementations

impl Clone for Logger

fn clone(&self) -> Logger

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Logger

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

Formats the value using the given formatter.

impl Default for Logger

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Logger

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Logger

fn cmp(&self, other: &Logger) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Logger

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

fn partial_cmp(&self, other: &Logger) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> ToLogParams<'a> for &'a Logger

fn to_log_params(self) -> LogParams<'a>

Convert the object into LogParams with default settings

fn once(self) -> LogParams<'a>

The logging should only happen once

fn skip_first(self) -> LogParams<'a>

The first time the logging happens, we should skip it

fn occurs(self, occurs: LogOccurrence) -> LogParams<'a>

Set the occurrence behavior of the log instance

fn throttle(self, throttle: Duration) -> LogParams<'a>

Set a throttling interval during which this log will not publish. A value of zero will never block the message from being published, and this is the default behavior.

fn throttle_clock(self, clock: ThrottleClock<'a>) -> LogParams<'a>

Set the clock that will be used to control throttling.

fn only_if(self, only_if: bool) -> LogParams<'a>

The log will not be published if a false expression is passed into this function.

fn debug(self) -> LogParams<'a>

Log as a debug message.

fn info(self) -> LogParams<'a>

Log as an informative message. This is the default, so you don’t generally need to use this.

fn warn(self) -> LogParams<'a>

Log as a warning message.

fn error(self) -> LogParams<'a>

Log as an error message.

fn fatal(self) -> LogParams<'a>

Log as a fatal message.

fn severity(self, severity: LogSeverity) -> LogParams<'a>

Set the severity for this instance of logging. The default value will be [LogSeverity::Info].

impl Eq for Logger

impl StructuralPartialEq for Logger