Struct IndicatifFilter

pub struct IndicatifFilter<S> { /* private fields */ }

A filter that filters based on the presence of a field with the name of either “indicatif.pb_show” or “indicatif.pb_hide” on the span.

The value for this field is irrelevant and not factored in to the filtering (this is due to tracing not making field values available in the on_new_span method). To avoid confusion, it is recommended to set the value of this field to tracing::field::Empty.

If both “indicatif.pb_show” and “indicatif.pb_hide” are present, the behavior is to show a progress bar.

Implementations

impl<S: Subscriber> IndicatifFilter<S>

pub fn new(show_progress_bars_by_default: bool) -> Self

Constructs the filter.

If “indicatif.pb_show” or “indicatif.pb_hide” are not present as a field on the span, then the value of show_progress_bars_by_default is used; i.e. if show_progress_bars_by_default is false, then progress bars are not shown for spans by default.

Trait Implementations

impl<S: Subscriber> Filter<S> for IndicatifFilter<S>

fn enabled(&self, meta: &Metadata<'_>, _: &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.

fn callsite_enabled(&self, meta: &'static Metadata<'static>) -> Interest

Returns an Interest indicating whether this layer will always, sometimes, or never be interested in the given Metadata.

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

Called before the filtered [Layer]'s [on_event], to determine if on_event` should be called.

fn max_level_hint(&self) -> Option<LevelFilter>

Returns an optional hint of the highest verbosity level that this Filter will enable.

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

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

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

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

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

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

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

Notifies this filter that a span with the given ID was exited.

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

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