Enum LevelFilter

#[repr(usize)]
pub enum LevelFilter {
    Off = 0,
    Error = 1,
    Warn = 2,
    Info = 3,
    Debug = 4,
    Trace = 5,
}

An enum representing the available verbosity level filters of the logger.

A LevelFilter may be compared directly to a Level. Use this type to get and set the maximum log level with max_level() and set_max_level.

Variants

Off = 0

A level lower than all log levels.

Error = 1

Corresponds to the Error log level.

Warn = 2

Corresponds to the Warn log level.

Info = 3

Corresponds to the Info log level.

Debug = 4

Corresponds to the Debug log level.

Trace = 5

Corresponds to the Trace log level.

Implementations

impl LevelFilter

pub fn max() -> LevelFilter

Returns the most verbose logging level filter.

pub fn to_level(&self) -> Option<Level>

Converts self to the equivalent Level.

Returns None if self is LevelFilter::Off.

pub fn as_str(&self) -> &'static str

Returns the string representation of the LevelFilter.

This returns the same string as the fmt::Display implementation.

pub fn iter() -> impl Iterator<Item = Self>

Iterate through all supported filtering levels.

The order of iteration is from less to more verbose filtering.

Examples

use log::LevelFilter;

let mut levels = LevelFilter::iter();

assert_eq!(Some(LevelFilter::Off), levels.next());
assert_eq!(Some(LevelFilter::Trace), levels.last());

pub fn increment_severity(&self) -> Self

Get the next-highest LevelFilter from this one.

If the current LevelFilter is at the highest level, the returned LevelFilter will be the same as the current one.

Examples

use log::LevelFilter;

let level_filter = LevelFilter::Info;

assert_eq!(LevelFilter::Debug, level_filter.increment_severity());
assert_eq!(LevelFilter::Trace, level_filter.increment_severity().increment_severity());
assert_eq!(LevelFilter::Trace, level_filter.increment_severity().increment_severity().increment_severity()); // max level

pub fn decrement_severity(&self) -> Self

Get the next-lowest LevelFilter from this one.

If the current LevelFilter is at the lowest level, the returned LevelFilter will be the same as the current one.

Examples

use log::LevelFilter;

let level_filter = LevelFilter::Info;

assert_eq!(LevelFilter::Warn, level_filter.decrement_severity());
assert_eq!(LevelFilter::Error, level_filter.decrement_severity().decrement_severity());
assert_eq!(LevelFilter::Off, level_filter.decrement_severity().decrement_severity().decrement_severity());
assert_eq!(LevelFilter::Off, level_filter.decrement_severity().decrement_severity().decrement_severity().decrement_severity()); // min level

Trait Implementations

impl Clone for LevelFilter

fn clone(&self) -> LevelFilter

Returns a duplicate 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, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromStr for LevelFilter

type Err = ParseLevelError

The associated error which can be returned from parsing.

fn from_str(level: &str) -> Result<LevelFilter, 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: &LevelFilter) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<Level> for LevelFilter

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

Tests for self and other values to be equal, and is used by ==.

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 ==.

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 ==.

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.

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

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

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

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

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

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

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

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: &Rhs) -> bool

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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 StructuralPartialEq for LevelFilter