Struct pyo3_log::Logger

pub struct Logger { /* fields omitted */ }

The Logger

The actual Logger that can be installed into the Rust side and will send messages over to Python.

It can be either created directly and then installed, passed to other aggregating log systems, or the init or try_init functions may be used if defaults are good enough.

Implementations

impl Logger

pub fn new(py: Python<'_>, caching: Caching) -> PyResult<Self>

Creates a new logger.

It defaults to having a filter for Debug.

pub fn install(self) -> Result<ResetHandle, SetLoggerError>

Installs this logger as the global one.

When installing, it also sets the corresponding maximum level, constructed using the filters in this logger.

pub fn reset_handle(&self) -> ResetHandle

Provides the reset handle of this logger.

Note that installing the logger also returns a reset handle. This function is available if, for example, the logger will be passed to some other logging system that connects multiple loggers together.

pub fn filter(self, filter: LevelFilter) -> Self

Configures the default logging filter.

Log messages will be filtered according a filter. If one provided by a filter_target matches, it takes preference. If none matches, this one is used.

The default filter if none set is Debug.

pub fn filter_target(self, target: String, filter: LevelFilter) -> Self

Sets a filter for a specific target, overriding the default.

This’ll match targets with the same name and all the children in the module hierarchy. In case multiple match, the most specific one wins.

With this configuration, modules will log in the following levels:

Logger::default()
    .filter(LevelFilter::Warn)
    .filter_target("xy".to_owned(), LevelFilter::Debug)
    .filter_target("xy::aa".to_owned(), LevelFilter::Trace);

• whatever => Warn
• xy => Debug
• xy::aa => Trace
• xy::aabb => Debug

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 Log for Logger

fn enabled(&self, metadata: &Metadata<'_>) -> bool

Determines if a log message with the specified metadata would be logged.

fn log(&self, record: &Record<'_>)

Logs the Record.

fn flush(&self)

Flushes any buffered records.