Struct Dispatch

pub struct Dispatch { /* private fields */ }

Dispatch trace data to a Subscriber.

Implementations

impl Dispatch

pub fn none() -> Dispatch

Available on crate feature cpu_os_threads only.

Returns a new Dispatch that discards events and spans.

pub fn new<S>(subscriber: S) -> Dispatch

where S: Subscriber + Send + Sync + 'static,

Available on crate feature cpu_os_threads only.

Returns a Dispatch that forwards to the given Subscriber.

pub fn downgrade(&self) -> WeakDispatch

Available on crate feature cpu_os_threads only.

Creates a WeakDispatch from this Dispatch.

A WeakDispatch is similar to a Dispatch, but it does not prevent the underlying Subscriber from being dropped. Instead, it only permits access while other references to the Subscriber exist. This is equivalent to the standard library’s Arc::downgrade method, but for Dispatch rather than Arc.

The primary use for creating a WeakDispatch is to allow a Subscriber to hold a cyclical reference to itself without creating a memory leak. See here for details.

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

Available on crate feature cpu_os_threads only.

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

Available on crate feature cpu_os_threads only.

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<'_>)

Available on crate feature cpu_os_threads only.

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)

Available on crate feature cpu_os_threads only.

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

Available on crate feature cpu_os_threads only.

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<'_>)

Available on crate feature cpu_os_threads only.

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)

Available on crate feature cpu_os_threads only.

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)

Available on crate feature cpu_os_threads only.

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

Available on crate feature cpu_os_threads only.

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

Available on crate feature cpu_os_threads only.

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.

    Deprecated: The 
    try_close method is functionally identical, but returns
    true if the span is now closed. It should be used
    instead of this method.

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

Available on crate feature cpu_os_threads only.

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

Available on crate feature cpu_os_threads only.

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>(&self) -> bool

where T: Any,

Available on crate feature cpu_os_threads only.

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

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

where T: Any,

Available on crate feature cpu_os_threads only.

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 Debug for Dispatch

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

Formats the value using the given formatter.

impl Default for Dispatch

fn default() -> Dispatch

Returns the current default dispatcher

impl<S> From<S> for Dispatch

where S: Subscriber + Send + Sync + 'static,

fn from(subscriber: S) -> Dispatch

Converts to this type from the input type.