๐Ÿ›ˆ Note: This is pre-release documentation for the upcoming tracing 0.2.0 ecosystem.

For the release documentation, please see docs.rs, instead.

Struct LevelFilter

pub struct LevelFilter(/* private fields */);
Expand description

A filter comparable to a verbosity Level.

If a Level is considered less than or equal to a LevelFilter, it should be considered enabled; if greater than the LevelFilter, that level is disabled. See LevelFilter::current for more details.

Note that this is essentially identical to the Level type, but with the addition of an OFF level that completely disables all trace instrumentation.

See the documentation for the Level type to see how Levels and LevelFilters interact.

Implementationsยง

ยง

impl LevelFilter

pub const OFF: LevelFilter

The โ€œoffโ€ level.

Designates that trace instrumentation should be completely disabled.

pub const ERROR: LevelFilter

The โ€œerrorโ€ level.

Designates very serious errors.

pub const WARN: LevelFilter

The โ€œwarnโ€ level.

Designates hazardous situations.

pub const INFO: LevelFilter

The โ€œinfoโ€ level.

Designates useful information.

pub const DEBUG: LevelFilter

The โ€œdebugโ€ level.

Designates lower priority information.

pub const TRACE: LevelFilter

The โ€œtraceโ€ level.

Designates very low priority, often extremely verbose, information.

pub const fn from_level(level: Level) -> LevelFilter

Returns a LevelFilter that enables spans and events with verbosity up to and including level.

pub const fn into_level(self) -> Option<Level>

Returns the most verbose Level that this filter accepts, or None if it is OFF.

pub fn current() -> LevelFilter

Returns a LevelFilter that matches the most verbose Level that any currently active collector will enable.

User code should treat this as a hint. If a given span or event has a level higher than the returned LevelFilter, it will not be enabled. However, if the level is less than or equal to this value, the span or event is not guaranteed to be enabled; the collector will still filter each callsite individually.

Therefore, comparing a given span or eventโ€™s level to the returned LevelFilter can be used for determining if something is disabled, but should not be used for determining if something is enabled.

Trait Implementationsยง

ยง

impl Clone for LevelFilter

ยง

fn clone(&self) -> LevelFilter

Returns a copy of the value. Read more
1.0.0 ยท Sourceยง

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

Performs copy-assignment from source. Read more
ยง

impl Debug for LevelFilter

ยง

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

Formats the value using the given formatter. Read more
ยง

impl Display for LevelFilter

ยง

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

Formats the value using the given formatter. Read more
ยง

impl From<Level> for LevelFilter

ยง

fn from(level: Level) -> LevelFilter

Converts to this type from the input type.
ยง

impl From<LevelFilter> for Option<Level>

ยง

fn from(filter: LevelFilter) -> Option<Level>

Converts to this type from the input type.
ยง

impl From<Option<Level>> for LevelFilter

ยง

fn from(level: Option<Level>) -> LevelFilter

Converts to this type from the input type.
ยง

impl FromStr for LevelFilter

ยง

type Err = ParseLevelFilterError

The associated error which can be returned from parsing.
ยง

fn from_str(from: &str) -> Result<LevelFilter, <LevelFilter as FromStr>::Err>

Parses a string s to return a value of this type. Read more
ยง

impl Hash for LevelFilter

ยง

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 ยท Sourceยง

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
ยง

impl Ord for LevelFilter

ยง

fn cmp(&self, other: &LevelFilter) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 ยท Sourceยง

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 ยท Sourceยง

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 ยท Sourceยง

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
ยง

impl PartialEq<Level> for LevelFilter

ยง

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 ยท Sourceยง

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
ยง

impl PartialEq<LevelFilter> for Level

ยง

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 ยท Sourceยง

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
ยง

impl PartialEq for LevelFilter

ยง

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 ยท Sourceยง

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
ยง

impl PartialOrd<Level> for LevelFilter

ยง

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

This method returns an ordering between self and other values if one exists. Read more
ยง

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

Tests less than (for self and other) and is used by the < operator. Read more
ยง

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
ยง

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

Tests greater than (for self and other) and is used by the > operator. Read more
ยง

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
ยง

impl PartialOrd<LevelFilter> for Level

ยง

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

This method returns an ordering between self and other values if one exists. Read more
ยง

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

Tests less than (for self and other) and is used by the < operator. Read more
ยง

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
ยง

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

Tests greater than (for self and other) and is used by the > operator. Read more
ยง

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
ยง

impl PartialOrd for LevelFilter

ยง

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

This method returns an ordering between self and other values if one exists. Read more
ยง

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

Tests less than (for self and other) and is used by the < operator. Read more
ยง

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
ยง

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

Tests greater than (for self and other) and is used by the > operator. Read more
ยง

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
ยง

impl Copy for LevelFilter

ยง

impl Eq for LevelFilter

ยง

impl StructuralPartialEq for LevelFilter

Auto Trait Implementationsยง

Blanket Implementationsยง

Sourceยง

impl<T> Any for T
where T: 'static + ?Sized,

Sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Sourceยง

impl<T> Borrow<T> for T
where T: ?Sized,

Sourceยง

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Sourceยง

impl<T> BorrowMut<T> for T
where T: ?Sized,

Sourceยง

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Sourceยง

impl<T> CloneToUninit for T
where T: Clone,

Sourceยง

unsafe fn clone_to_uninit(&self, dest: *mut u8)

๐Ÿ”ฌThis is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dest. Read more
Sourceยง

impl<T> From<T> for T

Sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

Sourceยง

impl<T> Instrument for T

Sourceยง

fn instrument(self, span: Span) -> Instrumented<Self> โ“˜

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

fn in_current_span(self) -> Instrumented<Self> โ“˜

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

impl<T, U> Into<U> for T
where U: From<T>,

Sourceยง

fn into(self) -> U

Calls U::from(self).

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

Sourceยง

impl<T> ToOwned for T
where T: Clone,

Sourceยง

type Owned = T

The resulting type after obtaining ownership.
Sourceยง

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T> ToString for T
where T: Display + ?Sized,

Sourceยง

fn to_string(&self) -> String

Converts the given value to a String. Read more
Sourceยง

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Sourceยง

type Error = Infallible

The type returned in the event of a conversion error.
Sourceยง

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Sourceยง

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Sourceยง

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Sourceยง

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Sourceยง

impl<T> WithCollector for T

Sourceยง

fn with_collector<C>(self, collector: C) -> WithDispatch<Self> โ“˜
where C: Into<Dispatch>,

Available on crate feature std only.
Attaches the provided collector to this type, returning a WithDispatch wrapper. Read more
Sourceยง

fn with_current_collector(self) -> WithDispatch<Self> โ“˜

Available on crate feature std only.
Attaches the current default collector to this type, returning a WithDispatch wrapper. Read more