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, andmod_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
impl LogSpecification
impl LogSpecification
pub fn off() -> LogSpecification
pub fn off() -> LogSpecification
Returns a LogSpecification
where all log output is switched off.
pub fn info() -> LogSpecification
pub fn info() -> LogSpecification
Returns a LogSpecification
where the global tracelevel is set to info.
pub fn parse<S>(spec: S) -> Result<LogSpecification, FlexiLoggerError> where
S: AsRef<str>,
pub fn parse<S>(spec: S) -> Result<LogSpecification, FlexiLoggerError> where
S: AsRef<str>,
Returns a log specification from a String.
Errors
FlexiLoggerError::Parse
if the input is malformed.
pub fn env() -> Result<LogSpecification, FlexiLoggerError>
pub fn env() -> Result<LogSpecification, FlexiLoggerError>
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.
pub fn env_or_parse<S>(
given_spec: S
) -> Result<LogSpecification, FlexiLoggerError> where
S: AsRef<str>,
pub fn env_or_parse<S>(
given_spec: S
) -> Result<LogSpecification, FlexiLoggerError> where
S: AsRef<str>,
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.
pub fn builder() -> LogSpecBuilder
pub fn builder() -> LogSpecBuilder
Creates a LogSpecBuilder
, which allows building a log spec programmatically.
pub fn from_toml<S>(s: S) -> Result<LogSpecification, FlexiLoggerError> where
S: AsRef<str>,
pub fn from_toml<S>(s: S) -> Result<LogSpecification, FlexiLoggerError> where
S: AsRef<str>,
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.
pub fn to_toml(&self, w: &mut dyn Write) -> Result<(), FlexiLoggerError>
pub fn to_toml(&self, w: &mut dyn Write) -> Result<(), FlexiLoggerError>
Serializes itself in toml format.
This method is only avaible with feature specfile
.
Errors
FlexiLoggerError::SpecfileIo
if writing fails.
pub fn enabled(&self, level: Level, writing_module: &str) -> bool
pub fn enabled(&self, level: Level, writing_module: &str) -> bool
Returns true if messages on the specified level from the writing module should be written.
pub fn module_filters(&self) -> &Vec<ModuleFilter, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
pub fn module_filters(&self) -> &Vec<ModuleFilter, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
Provides a reference to the module filters.
pub fn text_filter(&self) -> Option<&Regex>
pub fn text_filter(&self) -> Option<&Regex>
Provides a reference to the text filter.
This method is only avaible if the default feature textfilter
is not switched off.
Trait Implementations
impl Clone for LogSpecification
impl Clone for LogSpecification
fn clone(&self) -> LogSpecification
fn clone(&self) -> LogSpecification
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for LogSpecification
impl Debug for LogSpecification
impl Default for LogSpecification
impl Default for LogSpecification
fn default() -> LogSpecification
fn default() -> LogSpecification
Returns the “default value” for a type. Read more
impl ToString for LogSpecification
impl ToString for LogSpecification
impl<'_> TryFrom<&String> for LogSpecification
impl<'_> TryFrom<&String> for LogSpecification
type Error = FlexiLoggerError
type Error = FlexiLoggerError
The type returned in the event of a conversion error.
fn try_from(
value: &String
) -> Result<LogSpecification, <LogSpecification as TryFrom<&String>>::Error>
fn try_from(
value: &String
) -> Result<LogSpecification, <LogSpecification as TryFrom<&String>>::Error>
Performs the conversion.
impl<'_> TryFrom<&str> for LogSpecification
impl<'_> TryFrom<&str> for LogSpecification
type Error = FlexiLoggerError
type Error = FlexiLoggerError
The type returned in the event of a conversion error.
fn try_from(
value: &str
) -> Result<LogSpecification, <LogSpecification as TryFrom<&str>>::Error>
fn try_from(
value: &str
) -> Result<LogSpecification, <LogSpecification as TryFrom<&str>>::Error>
Performs the conversion.
Auto Trait Implementations
impl RefUnwindSafe for LogSpecification
impl Send for LogSpecification
impl Sync for LogSpecification
impl Unpin for LogSpecification
impl UnwindSafe for LogSpecification
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<W, Global>impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<W, Global>impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
W: Write + ?Sized, impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
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
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
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
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
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
impl<A> DynCastExt for A
impl<A> DynCastExt for A
fn dyn_cast<T>(
self
) -> Result<<A as DynCastExtHelper<T>>::Target, <A as DynCastExtHelper<T>>::Source> where
A: DynCastExtHelper<T>,
T: ?Sized,
fn dyn_cast<T>(
self
) -> Result<<A as DynCastExtHelper<T>>::Target, <A as DynCastExtHelper<T>>::Source> where
A: DynCastExtHelper<T>,
T: ?Sized,
Use this to cast from one trait object type to another. Read more
fn dyn_upcast<T>(self) -> <A as DynCastExtAdvHelper<T, T>>::Target where
A: DynCastExtAdvHelper<T, T, Source = <A as DynCastExtAdvHelper<T, T>>::Target>,
T: ?Sized,
fn dyn_upcast<T>(self) -> <A as DynCastExtAdvHelper<T, T>>::Target where
A: DynCastExtAdvHelper<T, T, Source = <A as DynCastExtAdvHelper<T, T>>::Target>,
T: ?Sized,
Use this to upcast a trait to one of its supertraits. Read more
fn dyn_cast_adv<F, T>(
self
) -> Result<<A as DynCastExtAdvHelper<F, T>>::Target, <A as DynCastExtAdvHelper<F, T>>::Source> where
A: DynCastExtAdvHelper<F, T>,
F: ?Sized,
T: ?Sized,
fn dyn_cast_adv<F, T>(
self
) -> Result<<A as DynCastExtAdvHelper<F, T>>::Target, <A as DynCastExtAdvHelper<F, T>>::Source> where
A: DynCastExtAdvHelper<F, T>,
F: ?Sized,
T: ?Sized,
fn dyn_cast_with_config<C>(
self
) -> Result<<A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Target, <A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Source> where
C: DynCastConfig,
A: DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>,
fn dyn_cast_with_config<C>(
self
) -> Result<<A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Target, <A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Source> where
C: DynCastConfig,
A: DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>,
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
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more