Struct LogParams

pub struct LogParams<'a> { /* private fields */ }

These parameters determine the behavior of an instance of logging.

Implementations

impl<'a> LogParams<'a>

pub fn new(logger_name: LoggerName<'a>) -> Self

Create a set of default log parameters, given the name of a logger

pub fn get_logger_name(&self) -> &LoggerName<'_>

Get the logger name

pub fn get_severity(&self) -> LogSeverity

Get the severity of the log

pub fn get_occurence(&self) -> LogOccurrence

Get the occurrence

pub fn get_throttle(&self) -> Duration

Get the throttle interval duration

pub fn get_throttle_clock(&self) -> ThrottleClock<'a>

Get the throttle clock

pub fn get_user_filter(&self) -> bool

Get the arbitrary filter set by the user

Trait Implementations

impl<'a> Clone for LogParams<'a>

fn clone(&self) -> LogParams<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for LogParams<'a>

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

Formats the value using the given formatter.

impl<'a> ToLogParams<'a> for LogParams<'a>

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<'a> Copy for LogParams<'a>