Struct tracing_subscriber::filter::Builder

source ·
pub struct Builder { /* private fields */ }
Expand description

A builder for constructing new EnvFilters.

Implementations§

source§

impl Builder

source

pub fn with_regex(self, regex: bool) -> Self

Sets whether span field values can be matched with regular expressions.

If this is true, field filter directives will be interpreted as regular expressions if they are not able to be interpreted as a bool, i64, u64, or f64 literal. If this is false, those field values will be interpreted as literal std::fmt::Debug output instead.

By default, regular expressions are enabled.

Note: when EnvFilters are constructed from untrusted inputs, disabling regular expressions is strongly encouraged.

source

pub fn with_default_directive(self, default_directive: Directive) -> Self

Sets a default [filtering directive] that will be added to the filter if the parsed string or environment variable contains no filter directives.

By default, there is no default directive.

§Examples

If parse, parse_lossy, from_env, or from_env_lossy are called with an empty string or environment variable, the default directive is used instead:

use tracing_subscriber::filter::{EnvFilter, LevelFilter};

let filter = EnvFilter::builder()
    .with_default_directive(LevelFilter::INFO.into())
    .parse("")?;

assert_eq!(format!("{}", filter), "info");

Note that the lossy variants (parse_lossy and from_env_lossy) will ignore any invalid directives. If all directives in a filter string or environment variable are invalid, those methods will also use the default directive:

use tracing_subscriber::filter::{EnvFilter, LevelFilter};

let filter = EnvFilter::builder()
    .with_default_directive(LevelFilter::INFO.into())
    .parse_lossy("some_target=fake level,foo::bar=lolwut");

assert_eq!(format!("{}", filter), "info");

If the string or environment variable contains valid filtering directives, the default directive is not used:

use tracing_subscriber::filter::{EnvFilter, LevelFilter};

let filter = EnvFilter::builder()
    .with_default_directive(LevelFilter::INFO.into())
    .parse_lossy("foo=trace");

// The default directive is *not* used:
assert_eq!(format!("{}", filter), "foo=trace");

Parsing a more complex default directive from a string:

use tracing_subscriber::filter::{EnvFilter, LevelFilter};

let default = "myapp=debug".parse()
    .expect("hard-coded default directive should be valid");

let filter = EnvFilter::builder()
    .with_default_directive(default)
    .parse("")?;

assert_eq!(format!("{}", filter), "myapp=debug");
source

pub fn with_env_var(self, var: impl ToString) -> Self

Sets the name of the environment variable used by the from_env, from_env_lossy, and try_from_env methods.

By default, this is the value of EnvFilter::DEFAULT_ENV (RUST_LOG).

source

pub fn parse_lossy<S: AsRef<str>>(&self, dirs: S) -> EnvFilter

Returns a new EnvFilter from the directives in the given string, ignoring any that are invalid.

source

pub fn parse<S: AsRef<str>>(&self, dirs: S) -> Result<EnvFilter, ParseError>

Returns a new EnvFilter from the directives in the given string, or an error if any are invalid.

source

pub fn from_env_lossy(&self) -> EnvFilter

Returns a new EnvFilter from the directives in the configured environment variable, ignoring any directives that are invalid.

source

pub fn from_env(&self) -> Result<EnvFilter, FromEnvError>

Returns a new EnvFilter from the directives in the configured environment variable. If the environment variable is unset, no directive is added.

An error is returned if the environment contains invalid directives.

source

pub fn try_from_env(&self) -> Result<EnvFilter, FromEnvError>

Returns a new EnvFilter from the directives in the configured environment variable, or an error if the environment variable is not set or contains invalid directives.

Trait Implementations§

source§

impl Clone for Builder

source§

fn clone(&self) -> Builder

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
source§

impl Debug for Builder

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Builder

source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> 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,

§

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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more