Struct ConsoleLogger 

pub struct ConsoleLogger { /* private fields */ }

Logger implementation that writes log records to the console.

This implementation of the Logger trait writes log records (Record) to the console using the provided log::Level. Log records with the Error kind ignore the provided log::Level and are always written with log::Level::Error.

Optionally, a prefix can be configured via with_prefix or set_prefix. When set, it is printed verbatim at the beginning of every log line, before the record kind character. This is useful to disambiguate output when several LoggedStreams (for example one per connection) log to the same console. No prefix is configured by default.

Implementations

impl ConsoleLogger

pub fn new(level: &str) -> Result<Self, ParseLevelError>

Construct a new instance of ConsoleLogger using the provided log level str. Returns an Err if the provided log level is invalid. The constructed logger has no prefix; use with_prefix or set_prefix to add one.

pub fn new_unchecked(level: &str) -> Self

Construct a new instance of ConsoleLogger using the provided log level str. Panics if the provided log level is invalid.

pub fn with_prefix(self, prefix: impl Into<Cow<'static, str>>) -> Self

Set a prefix that will be printed at the beginning of every log line produced by this logger, and return the modified logger. This is a chainable builder method.

The prefix is rendered verbatim immediately before the record kind character — no separator is inserted between them — so include any trailing separator you want yourself (for example a trailing space or brackets). An empty prefix therefore produces the same output as no prefix at all.

Examples

use logged_stream::ConsoleLogger;

let logger = ConsoleLogger::new_unchecked("debug").with_prefix("[conn 5] ");
assert_eq!(logger.prefix(), Some("[conn 5] "));

pub fn set_prefix(&mut self, prefix: impl Into<Cow<'static, str>>)

Set or replace the prefix printed at the beginning of every log line produced by this logger, in place. See with_prefix for details on how the prefix is rendered.

pub fn clear_prefix(&mut self)

Remove the configured prefix, so log lines are printed without any leading prefix again.

pub fn prefix(&self) -> Option<&str>

Return the currently configured prefix, or None if no prefix is set.

Trait Implementations

impl Clone for ConsoleLogger

fn clone(&self) -> ConsoleLogger

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConsoleLogger

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

Formats the value using the given formatter.

impl Logger for ConsoleLogger

fn log(&mut self, record: Record)

impl Logger for Box<ConsoleLogger>

fn log(&mut self, record: Record)