Struct Filtered

pub struct Filtered<S, F, C> { /* private fields */ }

Available on crate features registry and std only.

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

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

Implementations

impl<S, F, C> Filtered<S, F, C>

pub fn new(subscriber: S, filter: F) -> Self

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

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

See the documentation on per-subscriber filtering for details.

pub fn filter(&self) -> &F

Borrows the Filter used by this subscribe.

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

Mutably borrows the Filter used by this subscriber.

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

Examples

let filtered_subscriber = fmt::subscriber().with_filter(filter::LevelFilter::WARN);
let (filtered_subscriber, reload_handle) = reload::Subscriber::new(filtered_subscriber);
info!("This will be ignored");
reload_handle.modify(|subscriber| *subscriber.filter_mut() = filter::LevelFilter::INFO);
info!("This will be logged");

pub fn inner(&self) -> &S

Borrows the inner subscriber wrapped by this Filtered subscriber.

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

Mutably borrows the inner subscriber wrapped by this Filtered subscriber.

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

Examples

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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

where F: Debug, L: Debug,

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

Formats the value using the given formatter.

impl<C, S, F> Subscribe<C> for Filtered<S, F, C>

where C: Collect + for<'span> LookupSpan<'span> + 'static, F: Filter<C> + 'static, S: Subscribe<C>,

fn on_register_dispatch(&self, collector: &Dispatch)

Performs late initialization when installing this subscriber as a collector.

fn on_subscribe(&mut self, collector: &mut C)

Performs late initialization when attaching a subscriber to a collector.

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

Registers a new callsite with this subscriber, returning whether or not the subscriber is interested in being notified about the callsite, similarly to Collect::register_callsite.

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

Returns true if this subscriber is interested in a span or event with the given metadata in the current Context, similarly to Collect::enabled.

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

Notifies this subscriber that a new span was constructed with the given Attributes and Id.

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

Notifies this subscriber that a span with the given Id recorded the given values.

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

Notifies this subscriber that a span with the ID span recorded that it follows from the span with the ID follows.

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

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

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

Notifies this subscriber that an event has occurred.

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

Notifies this subscriber that a span with the given ID was entered.

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

Notifies this subscriber that the span with the given ID was exited.

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

Notifies this subscriber that the span with the given ID has been closed.

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

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

fn and_then<S>(self, subscriber: S) -> Layered<S, Self, C>

where S: Subscribe<C>, Self: Sized,

Composes this subscriber around the given collector, returning a Layered struct implementing Subscribe.

fn with_collector(self, inner: C) -> Layered<Self, C>

where Self: Sized,

Composes this subscriber with the given collector, returning a Layered struct that implements Collect.

fn with_filter<F>(self, filter: F) -> Filtered<Self, F, C>

where Self: Sized, F: Filter<C>,

Combines self with a Filter, returning a Filtered subscriber.

fn boxed(self) -> Box<dyn Subscribe<C> + Send + Sync + 'static>

where Self: Sized + Subscribe<C> + Send + Sync + 'static, C: Collect,

Available on crate features alloc or std only.

Erases the type of this subscriber, returning a Boxed dyn Subscribe trait object.