Struct tracing_core::metadata::LevelFilter

#[repr(transparent)]
pub struct LevelFilter(_);

A filter comparable to a verbosity Level.

If a Level is considered less than a LevelFilter, it should be considered enabled; if greater than or equal to 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) -> Self

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() -> Self

Returns a LevelFilter that matches the most verbose Level that any currently active Subscriber 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 subscriber 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.

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

Performs copy-assignment from source.

impl Debug for LevelFilter

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

Formats the value using the given formatter.

impl Display for LevelFilter

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

Formats the value using the given formatter.

impl From<Level> for LevelFilter

fn from(level: Level) -> Self

Converts to this type from the input type.

impl From<LevelFilter> for Option<Level>

fn from(filter: LevelFilter) -> Self

Converts to this type from the input type.

impl From<Option<Level>> for LevelFilter

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

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<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for LevelFilter

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 LevelFilter

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Level> for LevelFilter

fn eq(&self, other: &Level) -> 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 PartialEq<LevelFilter> for Level

fn eq(&self, other: &LevelFilter) -> 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 PartialEq<LevelFilter> for LevelFilter

fn eq(&self, other: &LevelFilter) -> 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<Level> for LevelFilter

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

impl PartialOrd<LevelFilter> for LevelFilter

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

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

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

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

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

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

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

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

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

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

impl Copy for LevelFilter

impl Eq for LevelFilter

impl StructuralEq for LevelFilter

impl StructuralPartialEq for LevelFilter