Struct TeXRayLayer

pub struct TeXRayLayer { /* private fields */ }

Tracing Layer to display a summary of spans.

Note: This layer does nothing on its own. It must be used in combination with examine to print the summary of a specific span.

Implementations

impl TeXRayLayer

pub fn new() -> Self

Create a new TeXRayLayer with settings from Settings::auto

pub fn init(self)

Install [TexRayLayer] as the global default

pub fn enable_events(self) -> Self

Show events in output in addition to spans

pub fn width(self, width: usize) -> Self

Override the rendered width

By default, the width is loaded by inspecting the TTY. If a TTY is not available, it defaults to 120

pub fn only_show_fields(self, fields: &[&'static str]) -> Self

When printing spans & events, only render the following fields

pub fn min_duration(self, duration: Duration) -> Self

Only render spans longer than duration

pub fn update_settings( self, f: impl FnOnce(&mut Settings) -> &mut Settings, ) -> Self

Update the settings of this [TexRayLayer]

pub fn writer(self, writer: impl Write + Send + 'static) -> Self

Updates the writer used to dump output

Trait Implementations

impl Clone for TeXRayLayer

fn clone(&self) -> TeXRayLayer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TeXRayLayer

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

Formats the value using the given formatter.

impl Default for TeXRayLayer

fn default() -> Self

Returns the “default value” for a type.

impl<S> Layer<S> for TeXRayLayer

where S: Subscriber + for<'span> LookupSpan<'span> + Send + Sync,

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

Notifies this layer 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 layer that a span with the given Id recorded the given values.

fn on_event(&self, event: &TracingEvent<'_>, ctx: Context<'_, S>)

Notifies this layer that an event has occurred.

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

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

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

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

fn on_register_dispatch(&self, subscriber: &Dispatch)

Performs late initialization when installing this layer as a Subscriber.

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

Performs late initialization when attaching a Layer to a Subscriber.

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.

fn enabled(&self, metadata: &Metadata<'_>, ctx: 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 on_follows_from(&self, _span: &Id, _follows: &Id, _ctx: Context<'_, S>)

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

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

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

fn on_exit(&self, _id: &Id, _ctx: Context<'_, S>)

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

fn on_id_change(&self, _old: &Id, _new: &Id, _ctx: Context<'_, S>)

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

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.

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.

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.

fn boxed(self) -> Box<dyn Layer<S> + Send + Sync>

where Self: Sized + Layer<S> + Send + Sync + 'static, S: Subscriber,

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