Trait ToLogParams

Source

pub trait ToLogParams<'a>: Sized {
Show 13 methods    // Required method
    fn to_log_params(self) -> LogParams<'a>;

    // Provided methods
    fn once(self) -> LogParams<'a> { ... }
    fn skip_first(self) -> LogParams<'a> { ... }
    fn occurs(self, occurs: LogOccurrence) -> LogParams<'a> { ... }
    fn throttle(self, throttle: Duration) -> LogParams<'a> { ... }
    fn throttle_clock(self, clock: ThrottleClock<'a>) -> LogParams<'a> { ... }
    fn only_if(self, only_if: bool) -> LogParams<'a> { ... }
    fn debug(self) -> LogParams<'a> { ... }
    fn info(self) -> LogParams<'a> { ... }
    fn warn(self) -> LogParams<'a> { ... }
    fn error(self) -> LogParams<'a> { ... }
    fn fatal(self) -> LogParams<'a> { ... }
    fn severity(self, severity: LogSeverity) -> LogParams<'a> { ... }
}

Expand description

Methods for defining the behavior of a logging instance.

This trait is implemented by Logger, Node, and anything that a &str can be borrowed from, such as string literals ("my_str"), String, or Cow<str>.

Required Methods§

Source

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

Convert the object into LogParams with default settings

Provided Methods§

Source

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

The logging should only happen once

Source

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

The first time the logging happens, we should skip it

Source

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

Set the occurrence behavior of the log instance

Source

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.

A negative duration is not valid, but will be treated as a zero duration.

Source

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

Set the clock that will be used to control throttling.

Source

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

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

Other factors may prevent the log from being published if a true is passed in, such as ToLogParams::throttle or ToLogParams::once filtering the log.

Source