Struct tracing_subscriber::filter::Filtered
source · [−]pub struct Filtered<L, F, S> { /* private fields */ }
registry
only.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
sourceimpl<L, F, S> Filtered<L, F, S>
impl<L, F, S> Filtered<L, F, S>
sourcepub fn new(layer: L, filter: F) -> Self
Available on crate feature std
only.
pub fn new(layer: L, filter: F) -> Self
std
only.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.
sourcepub fn filter(&self) -> &F
Available on crate feature std
only.
pub fn filter(&self) -> &F
std
only.Borrows the Filter
used by this layer.
sourcepub fn filter_mut(&mut self) -> &mut F
Available on crate feature std
only.
pub fn filter_mut(&mut self) -> &mut F
std
only.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");
sourcepub fn inner(&self) -> &L
Available on crate feature std
only.
pub fn inner(&self) -> &L
std
only.Borrows the inner Layer
wrapped by this Filtered
layer.
sourcepub fn inner_mut(&mut self) -> &mut L
Available on crate feature std
only.
pub fn inner_mut(&mut self) -> &mut L
std
only.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
sourceimpl<L: Clone, F: Clone, S: Clone> Clone for Filtered<L, F, S>
Available on crate feature std
only.
impl<L: Clone, F: Clone, S: Clone> Clone for Filtered<L, F, S>
std
only.sourcefn clone(&self) -> Filtered<L, F, S>ⓘNotable traits for Filtered<L, F, S>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>,
fn clone(&self) -> Filtered<L, F, S>ⓘNotable traits for Filtered<L, F, S>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>,
S: Subscriber + for<'span> LookupSpan<'span> + 'static,
F: Filter<S> + 'static,
L: Layer<S>,
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<F, L, S> Debug for Filtered<F, L, S> where
F: Debug,
L: Debug,
Available on crate feature std
only.
impl<F, L, S> Debug for Filtered<F, L, S> where
F: Debug,
L: Debug,
std
only.sourceimpl<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>,
Available on crate feature std
only.
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>,
std
only.sourcefn on_layer(&mut self, subscriber: &mut S)
fn on_layer(&mut self, subscriber: &mut S)
Performs late initialization when attaching a Layer
to a
Subscriber
. Read more
sourcefn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest
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
sourcefn enabled(&self, metadata: &Metadata<'_>, cx: Context<'_, S>) -> bool
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
sourcefn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, cx: Context<'_, S>)
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
. Read more
sourcefn on_record(&self, span: &Id, values: &Record<'_>, cx: Context<'_, S>)
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
. Read more
sourcefn on_follows_from(&self, span: &Id, follows: &Id, cx: Context<'_, S>)
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
. Read more
sourcefn on_event(&self, event: &Event<'_>, cx: Context<'_, S>)
fn on_event(&self, event: &Event<'_>, cx: Context<'_, S>)
Notifies this layer that an event has occurred.
sourcefn on_enter(&self, id: &Id, cx: Context<'_, S>)
fn on_enter(&self, id: &Id, cx: Context<'_, S>)
Notifies this layer that a span with the given ID was entered.
sourcefn on_exit(&self, id: &Id, cx: Context<'_, S>)
fn on_exit(&self, id: &Id, cx: Context<'_, S>)
Notifies this layer that the span with the given ID was exited.
sourcefn on_close(&self, id: Id, cx: Context<'_, S>)
fn on_close(&self, id: Id, cx: Context<'_, S>)
Notifies this layer that the span with the given ID has been closed.
sourcefn on_id_change(&self, old: &Id, new: &Id, cx: Context<'_, S>)
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. Read more
sourcefn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool
fn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool
sourcefn and_then<L>(self, layer: L) -> Layered<L, Self, S>ⓘNotable traits for Layered<A, B, S>impl<S, A, B> Layer<S> for Layered<A, B, S> where
A: Layer<S>,
B: Layer<S>,
S: Subscriber,
where
L: Layer<S>,
Self: Sized,
fn and_then<L>(self, layer: L) -> Layered<L, Self, S>ⓘNotable traits for Layered<A, B, S>impl<S, A, B> Layer<S> for Layered<A, B, S> where
A: Layer<S>,
B: Layer<S>,
S: Subscriber,
where
L: Layer<S>,
Self: Sized,
A: Layer<S>,
B: Layer<S>,
S: Subscriber,
Composes this layer around the given Layer
, returning a Layered
struct implementing Layer
. Read more
sourcefn with_subscriber(self, inner: S) -> Layered<Self, S>ⓘNotable traits for Layered<A, B, S>impl<S, A, B> Layer<S> for Layered<A, B, S> where
A: Layer<S>,
B: Layer<S>,
S: Subscriber,
where
Self: Sized,
fn with_subscriber(self, inner: S) -> Layered<Self, S>ⓘNotable traits for Layered<A, B, S>impl<S, A, B> Layer<S> for Layered<A, B, S> where
A: Layer<S>,
B: Layer<S>,
S: Subscriber,
where
Self: Sized,
A: Layer<S>,
B: Layer<S>,
S: Subscriber,
Composes this Layer
with the given Subscriber
, returning a
Layered
struct that implements Subscriber
. Read more
sourcefn with_filter<F>(self, filter: F) -> Filtered<Self, F, S>ⓘNotable traits for Filtered<L, F, S>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>,
where
Self: Sized,
F: Filter<S>,
fn with_filter<F>(self, filter: F) -> Filtered<Self, F, S>ⓘNotable traits for Filtered<L, F, S>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>,
where
Self: Sized,
F: Filter<S>,
S: Subscriber + for<'span> LookupSpan<'span> + 'static,
F: Filter<S> + 'static,
L: Layer<S>,
sourcefn boxed(self) -> Box<dyn Layer<S> + Send + Sync + 'static>ⓘNotable traits for Box<dyn Filter<S> + Send + Sync + 'static>impl<S> Filter<S> for Box<dyn Filter<S> + Send + Sync + 'static>impl<L, S> Layer<S> for Box<L> where
L: Layer<S>,
S: Subscriber, impl<S> Layer<S> for Box<dyn Layer<S> + Send + Sync> where
S: Subscriber,
where
Self: Sized,
Self: Layer<S> + Send + Sync + 'static,
S: Subscriber,
fn boxed(self) -> Box<dyn Layer<S> + Send + Sync + 'static>ⓘNotable traits for Box<dyn Filter<S> + Send + Sync + 'static>impl<S> Filter<S> for Box<dyn Filter<S> + Send + Sync + 'static>impl<L, S> Layer<S> for Box<L> where
L: Layer<S>,
S: Subscriber, impl<S> Layer<S> for Box<dyn Layer<S> + Send + Sync> where
S: Subscriber,
where
Self: Sized,
Self: Layer<S> + Send + Sync + 'static,
S: Subscriber,
L: Layer<S>,
S: Subscriber, impl<S> Layer<S> for Box<dyn Layer<S> + Send + Sync> where
S: Subscriber,
alloc
or std
only.Auto Trait Implementations
impl<L, F, S> RefUnwindSafe for Filtered<L, F, S> where
F: RefUnwindSafe,
L: RefUnwindSafe,
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more