Struct tracing_core::dispatcher::Dispatch

pub struct Dispatch { /* fields omitted */ }

Dispatch trace data to a Subscriber.

Methods

impl Dispatch

pub fn none() -> Self

Returns a new Dispatch that discards events and spans.

pub fn new<S>(subscriber: S) -> Self where
    S: Subscriber + Send + Sync + 'static, 

Returns a Dispatch that forwards to the given Subscriber.

pub 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.

This calls the register_callsite function on the Subscriber that this Dispatch forwards to.

pub fn new_span(&self, span: &Attributes) -> Id

Record the construction of a new span, returning a new ID for the span being constructed.

This calls the new_span function on the Subscriber that this Dispatch forwards to.

pub fn record(&self, span: &Id, values: &Record)

Record a set of values on a span.

This calls the record function on the Subscriber that this Dispatch forwards to.

pub fn record_follows_from(&self, span: &Id, follows: &Id)

Adds an indication that span follows from the span with the id follows.

This calls the record_follows_from function on the Subscriber that this Dispatch forwards to.

pub fn enabled(&self, metadata: &Metadata) -> bool

Returns true if a span with the specified metadata would be recorded.

This calls the enabled function on the Subscriber that this Dispatch forwards to.

pub fn event(&self, event: &Event)

Records that an Event has occurred.

This calls the event function on the Subscriber that this Dispatch forwards to.

pub fn enter(&self, span: &Id)

Records that a span has been can_enter.

This calls the [enter] function on the Subscriber that this Dispatch forwards to.

pub fn exit(&self, span: &Id)

Records that a span has been exited.

This calls the exit function on the Subscriber that this Dispatch forwards to.

pub fn clone_span(&self, id: &Id) -> Id

Notifies the subscriber that a span ID has been cloned.

This function must only be called with span IDs that were returned by this Dispatch's new_span function. The tracing crate upholds this guarantee and any other libraries implementing instrumentation APIs must as well.

This calls the clone_span function on the Subscriber that this Dispatch forwards to.

pub fn drop_span(&self, id: Id)

Deprecated since 0.1.2:

use Dispatch::try_close instead

Notifies the subscriber that a span ID has been dropped.

This function must only be called with span IDs that were returned by this Dispatch's new_span function. The tracing crate upholds this guarantee and any other libraries implementing instrumentation APIs must as well.

This calls the [drop_span] function on the Subscriber that this Dispatch forwards to.

Note: the try_close function is functionally identical, but returns true if the span is now closed.

pub fn try_close(&self, id: Id) -> bool

Notifies the subscriber that a span ID has been dropped, and returns true if there are now 0 IDs referring to that span.

This function must only be called with span IDs that were returned by this Dispatch's new_span function. The tracing crate upholds this guarantee and any other libraries implementing instrumentation APIs must as well.

This calls the try_close function on the Subscriber that this Dispatch forwards to.

pub fn current_span(&self) -> Current

Returns a type representing this subscriber's view of the current span.

This calls the current function on the Subscriber that this Dispatch forwards to.

pub fn is<T: Any>(&self) -> bool

Returns true if this Dispatch forwards to a Subscriber of type T.

pub fn downcast_ref<T: Any>(&self) -> Option<&T>

Returns some reference to the Subscriber this Dispatch forwards to if it is of type T, or None if it isn't.

Trait Implementations

impl Clone for Dispatch

fn clone(&self) -> Dispatch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> From<S> for Dispatch where
    S: Subscriber + Send + Sync + 'static, 

fn from(subscriber: S) -> Self

Performs the conversion.

impl Debug for Dispatch

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

Formats the value using the given formatter.