pub struct LogSpecification { /* private fields */ }
Expand description

Immutable struct that defines which loglines are to be written, based on the module, the log level, and the text.

Providing the loglevel specification via String (LogSpecification::parse and LogSpecification::env) works essentially like with env_logger, but we are a bit more tolerant with spaces. Its functionality can be described with some Backus-Naur-form:

<log_level_spec> ::= single_log_level_spec[{,single_log_level_spec}][/<text_filter>]
<single_log_level_spec> ::= <path_to_module>|<log_level>|<path_to_module>=<log_level>
<text_filter> ::= <regex>
  • Examples:

    • "info": all logs with info, warn, or error level are written
    • "crate1": all logs of this crate are written, but nothing else
    • "warn, crate2::mod_a=debug, mod_x::mod_y=trace": all crates log warnings and errors, mod_a additionally debug messages, and mod_x::mod_y is fully traced
  • If you just specify the module, without log_level, all levels will be traced for this module.

  • If you just specify a log level, this will be applied as default to all modules without explicit log level assigment. (You see that for modules named error, warn, info, debug or trace, it is necessary to specify their loglevel explicitly).

  • The module names are compared as Strings, with the side effect that a specified module filter affects all modules whose name starts with this String.
    Example: "foo" affects e.g.

    • foo
    • foo::bar
    • foobaz (!)
    • foobaz::bar (!)

The optional text filter is applied for all modules.

Note that external module names are to be specified like in "extern crate ...", i.e., for crates with a dash in their name this means: the dash is to be replaced with the underscore (e.g. karl_heinz, not karl-heinz). See https://github.com/rust-lang/rfcs/pull/940/files for an explanation of the different naming conventions in Cargo (packages allow hyphen) and rustc (“extern crate” does not allow hyphens).

Implementations

Returns a LogSpecification where all log output is switched off.

Returns a LogSpecification where the global tracelevel is set to info.

Returns a log specification from a String.

Errors

FlexiLoggerError::Parse if the input is malformed.

Returns a log specification based on the value of the environment variable RUST_LOG, or an empty one.

Errors

FlexiLoggerError::Parse if the input is malformed.

Returns a log specification based on the value of the environment variable RUST_LOG, if it exists and can be parsed, or on the given String.

Errors

FlexiLoggerError::Parse if the given spec is malformed.

Creates a LogSpecBuilder, which allows building a log spec programmatically.

Reads a log specification from an appropriate toml document.

This method is only avaible with feature specfile.

Errors

FlexiLoggerError::Parse if the input is malformed.

Serializes itself in toml format.

This method is only avaible with feature specfile.

Errors

FlexiLoggerError::SpecfileIo if writing fails.

Returns true if messages on the specified level from the writing module should be written.

Provides a reference to the module filters.

Provides a reference to the text filter.

This method is only avaible if the default feature textfilter is not switched off.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

Use this to cast from one trait object type to another. Read more

Use this to upcast a trait to one of its supertraits. Read more

Use this to cast from one trait object type to another. This method is more customizable than the dyn_cast method. Here you can also specify the “source” trait from which the cast is defined. This can for example allow using casts from a supertrait of the current trait object. Read more

Use this to cast from one trait object type to another. With this method the type parameter is a config type that uniquely specifies which cast should be preformed. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more