Struct tracing_core::dispatcher::Dispatch
source · pub struct Dispatch {
subscriber: Arc<dyn Subscriber + Send + Sync>,
}
Expand description
Dispatch
trace data to a Subscriber
.
Fields§
§subscriber: Arc<dyn Subscriber + Send + Sync>
Implementations§
source§impl Dispatch
impl Dispatch
sourcepub fn new<S>(subscriber: S) -> Selfwhere
S: Subscriber + Send + Sync + 'static,
pub fn new<S>(subscriber: S) -> Selfwhere
S: Subscriber + Send + Sync + 'static,
Returns a Dispatch
that forwards to the given Subscriber
.
pub(crate) fn registrar(&self) -> Registrar
sourcepub fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest
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.
sourcepub(crate) fn max_level_hint(&self) -> Option<LevelFilter>
pub(crate) fn max_level_hint(&self) -> Option<LevelFilter>
Returns the highest verbosity level that this Subscriber
will
enable, or None
, if the subscriber does not implement level-based
filtering or chooses not to implement this method.
This calls the [max_level_hint
] function on the Subscriber
that this Dispatch
forwards to.
sourcepub fn new_span(&self, span: &Attributes<'_>) -> Id
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.
sourcepub fn record(&self, span: &Id, values: &Record<'_>)
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.
sourcepub fn record_follows_from(&self, span: &Id, follows: &Id)
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.
sourcepub fn enabled(&self, metadata: &Metadata<'_>) -> bool
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.
sourcepub fn event(&self, event: &Event<'_>)
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.
sourcepub fn enter(&self, span: &Id)
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.
sourcepub fn exit(&self, span: &Id)
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.
sourcepub fn clone_span(&self, id: &Id) -> Id
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.
sourcepub fn drop_span(&self, id: Id)
👎Deprecated since 0.1.2: use Dispatch::try_close
instead
pub fn drop_span(&self, id: Id)
Dispatch::try_close
insteadNotifies 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: Thetry_close
method is functionally identical, but returnstrue
if the span is now closed. It should be used instead of this method.
sourcepub fn try_close(&self, id: Id) -> bool
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.
sourcepub fn current_span(&self) -> Current
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.
sourcepub fn is<T: Any>(&self) -> bool
pub fn is<T: Any>(&self) -> bool
Returns true
if this Dispatch
forwards to a Subscriber
of type
T
.
sourcepub fn downcast_ref<T: Any>(&self) -> Option<&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.