pub struct Filtered<L, F, S> { /* private fields */ }
Expand description

A Layer that wraps an inner Layer and adds a Filter which controls what spans and events are enabled for that layer.

This is returned by the Layer::with_filter method. See the documentation on per-layer filtering for details.

Implementations§

source§

impl<L, F, S> Filtered<L, F, S>

source

pub fn new(layer: L, filter: F) -> Self

Wraps the provided Layer so that it is filtered by the given Filter.

This is equivalent to calling the Layer::with_filter method.

See the documentation on per-layer filtering for details.

source

pub fn filter(&self) -> &F

Borrows the Filter used by this layer.

source

pub fn filter_mut(&mut self) -> &mut F

Mutably borrows the Filter used by this layer.

When this layer can be mutably borrowed, this may be used to mutate the filter. Generally, this will primarily be used with the reload::Handle::modify method.

Examples
let filtered_layer = fmt::Layer::default().with_filter(filter::LevelFilter::WARN);
let (filtered_layer, reload_handle) = reload::Layer::new(filtered_layer);
info!("This will be ignored");
reload_handle.modify(|layer| *layer.filter_mut() = filter::LevelFilter::INFO);
info!("This will be logged");
source

pub fn inner(&self) -> &L

Borrows the inner Layer wrapped by this Filtered layer.

source

pub fn inner_mut(&mut self) -> &mut L

Mutably borrows the inner Layer wrapped by this Filtered layer.

This method is primarily expected to be used with the reload::Handle::modify method.

Examples
let filtered_layer = fmt::layer().with_writer(non_blocking(std::io::stderr())).with_filter(filter::LevelFilter::INFO);
let (filtered_layer, reload_handle) = reload::Layer::new(filtered_layer);
info!("This will be logged to stderr");
reload_handle.modify(|layer| *layer.inner_mut().writer_mut() = non_blocking(std::io::stdout()));
info!("This will be logged to stdout");

Trait Implementations§

source§

impl<L: Clone, F: Clone, S: Clone> Clone for Filtered<L, F, S>

source§

fn clone(&self) -> Filtered<L, F, S>

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<F, L, S> Debug for Filtered<F, L, S>
where F: Debug, L: Debug,

source§

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

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

impl<S, L, F> Layer<S> for Filtered<L, F, S>
where S: Subscriber + for<'span> LookupSpan<'span> + 'static, F: Filter<S> + 'static, L: Layer<S>,

source§

fn on_register_dispatch(&self, collector: &Dispatch)

Performs late initialization when installing this layer as a Subscriber. Read more
source§

fn on_layer(&mut self, subscriber: &mut S)

Performs late initialization when attaching a Layer to a Subscriber. Read more
source§

fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest

Registers a new callsite with this layer, returning whether or not the layer is interested in being notified about the callsite, similarly to Subscriber::register_callsite. Read more
source§

fn enabled(&self, metadata: &Metadata<'_>, cx: Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the given metadata in the current Context, similarly to Subscriber::enabled. Read more
source§

fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, cx: Context<'_, S>)

Notifies this layer that a new span was constructed with the given Attributes and Id.
source§

fn on_record(&self, span: &Id, values: &Record<'_>, cx: Context<'_, S>)

Notifies this layer that a span with the given Id recorded the given values.
source§

fn on_follows_from(&self, span: &Id, follows: &Id, cx: Context<'_, S>)

Notifies this layer that a span with the ID span recorded that it follows from the span with the ID follows.
source§

fn event_enabled(&self, event: &Event<'_>, cx: Context<'_, S>) -> bool

Called before on_event, to determine if on_event should be called.
source§

fn on_event(&self, event: &Event<'_>, cx: Context<'_, S>)

Notifies this layer that an event has occurred.
source§

fn on_enter(&self, id: &Id, cx: Context<'_, S>)

Notifies this layer that a span with the given ID was entered.
source§

fn on_exit(&self, id: &Id, cx: Context<'_, S>)

Notifies this layer that the span with the given ID was exited.
source§

fn on_close(&self, id: Id, cx: Context<'_, S>)

Notifies this layer that the span with the given ID has been closed.
source§

fn on_id_change(&self, old: &Id, new: &Id, cx: Context<'_, S>)

Notifies this layer that a span ID has been cloned, and that the subscriber returned a different ID.
source§

fn and_then<L>(self, layer: L) -> Layered<L, Self, S>
where L: Layer<S>, Self: Sized,

Composes this layer around the given Layer, returning a Layered struct implementing Layer. Read more
source§

fn with_subscriber(self, inner: S) -> Layered<Self, S>
where Self: Sized,

Composes this Layer with the given Subscriber, returning a Layered struct that implements Subscriber. Read more
source§

fn with_filter<F>(self, filter: F) -> Filtered<Self, F, S>
where Self: Sized, F: Filter<S>,

Combines self with a Filter, returning a Filtered layer. Read more

Auto Trait Implementations§

§

impl<L, F, S> RefUnwindSafe for Filtered<L, F, S>

§

impl<L, F, S> Send for Filtered<L, F, S>
where F: Send, L: Send,

§

impl<L, F, S> Sync for Filtered<L, F, S>
where F: Sync, L: Sync,

§

impl<L, F, S> Unpin for Filtered<L, F, S>
where F: Unpin, L: Unpin,

§

impl<L, F, S> UnwindSafe for Filtered<L, F, S>
where F: UnwindSafe, L: UnwindSafe,

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