🛈 Note: This is pre-release documentation for the upcoming tracing 0.2.0 ecosystem.

For the release documentation, please see docs.rs, instead.

tracing_subscriber::registry

Struct SpanRef

Source
pub struct SpanRef<'a, R: LookupSpan<'a>> { /* private fields */ }
Expand description

A reference to [span data] and the associated registry.

This type implements all the same methods as SpanData, and provides additional methods for querying the registry based on values from the span.

Implementations§

Source§

impl<'a, R> SpanRef<'a, R>
where R: LookupSpan<'a>,

Source

pub fn id(&self) -> Id

Returns this span’s ID.

Source

pub fn metadata(&self) -> &'static Metadata<'static>

Returns a static reference to the span’s metadata.

Source

pub fn name(&self) -> &'static str

Returns the span’s name,

Source

pub fn fields(&self) -> &FieldSet

Returns a list of fields defined by the span.

Source

pub fn parent_id(&self) -> Option<&Id>

👎Deprecated since 0.2.21: this method cannot properly support per-subscriber filtering, and may return the Id of a disabled span if per-subscriber filtering is in use. use .parent().map(SpanRef::id) instead.

Returns the ID of this span’s parent, or None if this span is the root of its trace tree.

Source

pub fn parent(&self) -> Option<Self>

Returns a SpanRef describing this span’s parent, or None if this span is the root of its trace tree.

Source

pub fn scope(&self) -> Scope<'a, R>

Returns an iterator over all parents of this span, starting with this span, ordered from leaf to root.

The iterator will first return the span, then the span’s immediate parent, followed by that span’s parent, and so on, until it reaches a root span.

use tracing::{span, Collect};
use tracing_subscriber::{
    subscribe::{Context, Subscribe},
    prelude::*,
    registry::LookupSpan,
};

struct PrintingSubscriber;
impl<C> Subscribe<C> for PrintingSubscriber
where
    C: Collect + for<'lookup> LookupSpan<'lookup>,
{
    fn on_enter(&self, id: &span::Id, ctx: Context<C>) {
        let span = ctx.span(id).unwrap();
        let scope = span.scope().map(|span| span.name()).collect::<Vec<_>>();
        println!("Entering span: {:?}", scope);
    }
}

tracing::collect::with_default(tracing_subscriber::registry().with(PrintingSubscriber), || {
    let _root = tracing::info_span!("root").entered();
    // Prints: Entering span: ["root"]
    let _child = tracing::info_span!("child").entered();
    // Prints: Entering span: ["child", "root"]
    let _leaf = tracing::info_span!("leaf").entered();
    // Prints: Entering span: ["leaf", "child", "root"]
});

If the opposite order (from the root to this span) is desired, calling Scope::from_root on the returned iterator reverses the order.

impl<C> Subscribe<C> for PrintingSubscriber
where
    C: Collect + for<'lookup> LookupSpan<'lookup>,
{
    fn on_enter(&self, id: &span::Id, ctx: Context<C>) {
        let span = ctx.span(id).unwrap();
        let scope = span.scope().from_root().map(|span| span.name()).collect::<Vec<_>>();
        println!("Entering span: {:?}", scope);
    }
}

tracing::collect::with_default(tracing_subscriber::registry().with(PrintingSubscriber), || {
    let _root = tracing::info_span!("root").entered();
    // Prints: Entering span: ["root"]
    let _child = tracing::info_span!("child").entered();
    // Prints: Entering span: ["root", "child"]
    let _leaf = tracing::info_span!("leaf").entered();
    // Prints: Entering span: ["root", "child", "leaf"]
});
Source

pub fn extensions(&self) -> Extensions<'_>

Available on crate feature std only.

Returns a reference to this span’s Extensions.

The extensions may be used by Subscribers to store additional data describing the span.

Source

pub fn extensions_mut(&self) -> ExtensionsMut<'_>

Available on crate feature std only.

Returns a mutable reference to this span’s Extensions.

The extensions may be used by Subscribers to store additional data describing the span.

Trait Implementations§

Source§

impl<'a, R: Debug + LookupSpan<'a>> Debug for SpanRef<'a, R>
where R::Data: Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, R> Freeze for SpanRef<'a, R>
where <R as LookupSpan<'a>>::Data: Freeze,

§

impl<'a, R> RefUnwindSafe for SpanRef<'a, R>
where <R as LookupSpan<'a>>::Data: RefUnwindSafe, R: RefUnwindSafe,

§

impl<'a, R> Send for SpanRef<'a, R>
where <R as LookupSpan<'a>>::Data: Send, R: Sync,

§

impl<'a, R> Sync for SpanRef<'a, R>
where <R as LookupSpan<'a>>::Data: Sync, R: Sync,

§

impl<'a, R> Unpin for SpanRef<'a, R>
where <R as LookupSpan<'a>>::Data: Unpin,

§

impl<'a, R> UnwindSafe for SpanRef<'a, R>
where <R as LookupSpan<'a>>::Data: UnwindSafe, R: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithCollector for T

Source§

fn with_collector<C>(self, collector: C) -> WithDispatch<Self>
where C: Into<Dispatch>,

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

fn with_current_collector(self) -> WithDispatch<Self>

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