Struct otter_api_tests::shapelib::LogSpecification [−]
pub struct LogSpecification { /* fields omitted */ }
Immutable struct that defines which loglines are to be written, based on the module, the log level, and the text.
The loglevel specification via string (relevant for methods
parse() and
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
#[must_use]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
#[must_use]pub fn off() -> LogSpecification
Returns a LogSpecification
where all traces are switched off.
pub fn parse(spec: &str) -> Result<LogSpecification, FlexiLoggerError>
Returns a log specification from a String.
Errors
FlexiLoggerError::Parse
if the input is malformed.
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>,
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 from_toml(s: &str) -> Result<LogSpecification, FlexiLoggerError>
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>
Serializes itself in toml format.
This method is only avaible with feature specfile
.
Errors
FlexiLoggerError::Io
if writing fails.
#[must_use]pub fn default(level_filter: LevelFilter) -> LogSpecBuilder
Creates a LogSpecBuilder
, setting the default log level.
#[must_use]pub fn module_filters(&self) -> &Vec<ModuleFilter, Global>ⓘ
Provides a reference to the module filters.
#[must_use]pub fn text_filter(&self) -> Option<&Regex>
Provides a reference to the text filter.
This method is only avaible with feature textfilter
, which is a default feature.
Trait Implementations
impl Clone for LogSpecification
pub fn clone(&self) -> LogSpecification
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for LogSpecification
impl Default for LogSpecification
pub fn default() -> LogSpecification
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
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;
[src]
Notable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;
[src]
Notable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;
impl<T> Downcast for T where
T: Any,
T: Any,
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
A: Allocator + 'static,
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
A: Allocator,
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;
Notable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
A: Allocator + 'static,
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
A: Allocator,
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn as_any(&self) -> &(dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
impl<T> DowncastSync for T where
T: Any + Send + Sync,
T: Any + Send + Sync,
impl<A> DynCastExt for A
pub fn dyn_cast<T>(
self
) -> Result<<A as DynCastExtHelper<T>>::Target, <A as DynCastExtHelper<T>>::Source> where
T: ?Sized,
A: DynCastExtHelper<T>,
self
) -> Result<<A as DynCastExtHelper<T>>::Target, <A as DynCastExtHelper<T>>::Source> where
T: ?Sized,
A: DynCastExtHelper<T>,
pub fn dyn_upcast<T>(self) -> <A as DynCastExtAdvHelper<T, T>>::Target where
T: ?Sized,
A: DynCastExtAdvHelper<T, T, Source = <A as DynCastExtAdvHelper<T, T>>::Target>,
T: ?Sized,
A: DynCastExtAdvHelper<T, T, Source = <A as DynCastExtAdvHelper<T, T>>::Target>,
pub fn dyn_cast_adv<F, T>(
self
) -> Result<<A as DynCastExtAdvHelper<F, T>>::Target, <A as DynCastExtAdvHelper<F, T>>::Source> where
T: ?Sized,
A: DynCastExtAdvHelper<F, T>,
F: ?Sized,
self
) -> Result<<A as DynCastExtAdvHelper<F, T>>::Target, <A as DynCastExtAdvHelper<F, T>>::Source> where
T: ?Sized,
A: DynCastExtAdvHelper<F, T>,
F: ?Sized,
pub 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>,
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>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,