Struct tracing::Dispatch[][src]

pub struct Dispatch { /* fields omitted */ }
Expand description

Dispatch trace data to a Collect.

Implementations

Returns a new Dispatch that discards events and spans.

Returns a Dispatch that forwards to the given Collect.

Returns a Dispatch that forwards to the given static collector.

Unlike Dispatch::new, this function is always available on all platforms, even when the std or alloc features are disabled.

In order to use from_static, the Collector itself must be stored in a static. For example:

struct MyCollector {
   // ...
}

impl tracing_core::Collect for MyCollector {
    // ...
}

static COLLECTOR: MyCollector = MyCollector {
    // ...
};

fn main() {
    use tracing_core::dispatch::{self, Dispatch};

    let dispatch = Dispatch::from_static(&COLLECTOR);

    dispatch::set_global_default(dispatch)
        .expect("no global default collector should have been set previously!");
}

Constructing the collector in a static initializer may make some forms of runtime configuration more challenging. If this is the case, users with access to liballoc or the Rust standard library are encouraged to use Dispatch::new rather than from_static. no_std users who cannot allocate or do not have access to liballoc may want to consider the lazy_static crate, or another library which allows lazy initialization of statics.

Registers a new callsite with this collector, returning whether or not the collector is interested in being notified about the callsite.

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

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

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

Record a set of values on a span.

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

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

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

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

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

Records that an Event has occurred.

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

Records that a span has been can_enter.

This calls the enter function on the Collect that this Dispatch forwards to.

Records that a span has been exited.

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

Notifies the collector 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 Collect that this Dispatch forwards to.

👎 Deprecated since 0.1.2:

use Dispatch::try_close instead

Notifies the collector 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 Collect 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.

Notifies the collector 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 Collect trait that this Dispatch forwards to.

Returns a type representing this collector’s view of the current span.

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

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

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

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the current default dispatcher

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

This is supported on crate feature std only.

Attaches the provided collector to this type, returning a WithDispatch wrapper. Read more

This is supported on crate feature std only.

Attaches the current default collector to this type, returning a WithDispatch wrapper. Read more