Struct libpt_log::LoggerBuilder

pub struct LoggerBuilder { /* private fields */ }

Builder for a well configured Logger

This struct helps configure a global logger that can be used with either macros or methods, see Logger.

Examples

Logger::builder()
    .uptime(true)
    .build();
info!("hello world");

Implementations

impl LoggerBuilder

pub fn build(self) -> Result<Logger>

use the configured settings to build and initialize a new global Logger

This will build a functional Logger. You don’t need to use the Logger struct, it’s better to use the macros:

• error!
• warn!
• info!
• debug!
• trace!

instead of the methods of the Logger struct. You can however use the Logger struct in cases where usage of a macro is bad or you are somehow working with multiple loggers.

Examples

Logger::builder()
    .uptime(true)
    .build();
info!("hello world");

Errors

This function will return an error if a global Logger was aready initialized. This module uses the tracing crate for logging, so if a tracing logger is initialized elsewhere, this method will error.

pub const fn log_to_file(self, log_to_file: bool) -> Self

enable or disable logging to and creating of logfiles

If you want to log to a file, don’t forget to set Self::log_dir!

Default: false

pub fn log_dir(self, log_dir: PathBuf) -> Self

set a directory where logfiles would be created in

Enable or disable creation and logging to logfiles with log_to_file.

Default: DEFAULT_LOG_DIR (/dev/null)

pub const fn ansi(self, ansi: bool) -> Self

enable or disable ANSI control sequences

Disabling ANSI control sequences might improve compatibility and readability when the logs are displayed by a program that does not interpret them.

Keeping ANSI control sequences enabled has the disadvantage of added colors for the logs.

Default: true

pub const fn display_filename(self, display_filename: bool) -> Self

when making a log, display the source file in which a log was crated in

Default: false

pub const fn display_time(self, show_time: bool) -> Self

when making a log, display the time of the message

Default: true

pub const fn display_level(self, display_level: bool) -> Self

when making a log, display the log level of the message

Default: true

pub const fn display_target(self, display_target: bool) -> Self

show target context

Default: false

pub const fn display_thread_ids(self, display_thread_ids: bool) -> Self

show the id of the thread that created this message

Default: false

pub const fn display_thread_names(self, display_thread_names: bool) -> Self

show the name of the thread that created this message

Default: false

pub const fn display_line_number(self, display_line_number: bool) -> Self

show which line in the source file produces a log

Default: false

pub const fn pretty(self, pretty: bool) -> Self

splits a log over multiple lines, looks like a python traceback

Default: false

pub const fn uptime(self, uptime: bool) -> Self

show timestamps as uptime (duration since the logger was initialized)

Default: false

pub const fn set_level(self, max_level: Level) -> Self

set the lowest loglevel to be displayed

Default: Level::INFO

Trait Implementations

impl Debug for LoggerBuilder

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

Formats the value using the given formatter.

impl Default for LoggerBuilder

fn default() -> Self

Returns the “default value” for a type.

impl Hash for LoggerBuilder

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 LoggerBuilder

fn cmp(&self, other: &LoggerBuilder) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for LoggerBuilder

fn eq(&self, other: &LoggerBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for LoggerBuilder

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for LoggerBuilder

impl StructuralPartialEq for LoggerBuilder