pub struct FmtContext<'a, S, N> { /* private fields */ }
Expand description

Provides the current span context to a formatter.

Implementations§

source§

impl<'a, S, N> FmtContext<'a, S, N>where S: Subscriber + for<'lookup> LookupSpan<'lookup>, N: for<'writer> FormatFields<'writer> + 'static,

source

pub fn visit_spans<E, F>(&self, f: F) -> Result<(), E>where F: FnMut(&SpanRef<'_, S>) -> Result<(), E>,

Visits every span in the current context with a closure.

The provided closure will be called first with the current span, and then with that span’s parent, and then that span’s parent, and so on until a root span is reached.

source

pub fn metadata(&self, id: &Id) -> Option<&'static Metadata<'static>>where S: for<'lookup> LookupSpan<'lookup>,

Returns metadata for the span with the given id, if it exists.

If this returns None, then no span exists for that ID (either it has closed or the ID is invalid).

source

pub fn span(&self, id: &Id) -> Option<SpanRef<'_, S>>where S: for<'lookup> LookupSpan<'lookup>,

Returns stored data for the span with the given id, if it exists.

If this returns None, then no span exists for that ID (either it has closed or the ID is invalid).

source

pub fn exists(&self, id: &Id) -> boolwhere S: for<'lookup> LookupSpan<'lookup>,

Returns true if an active span exists for the given Id.

source

pub fn lookup_current(&self) -> Option<SpanRef<'_, S>>where S: for<'lookup> LookupSpan<'lookup>,

Returns stored data for the span that the wrapped subscriber considers to be the current.

If this returns None, then we are not currently within a span.

source

pub fn scope(&self) -> Scope<'_, S> where S: for<'lookup> LookupSpan<'lookup>,

👎Deprecated since 0.2.19: wraps layer::Context::scope, which is deprecated

Returns an iterator over the stored data for all the spans in the current context, starting the root of the trace tree and ending with the current span.

source

pub fn current_span(&self) -> Current

Returns the current span for this formatter.

source

pub fn field_format(&self) -> &N

Returns the field formatter configured by the subscriber invoking format_event.

The event formatter may use the returned field formatter to format the fields of any events it records.

Trait Implementations§

source§

impl<'a, S, N> Debug for FmtContext<'a, S, N>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'cx, 'writer, S, N> FormatFields<'writer> for FmtContext<'cx, S, N>where S: Subscriber + for<'lookup> LookupSpan<'lookup>, N: FormatFields<'writer> + 'static,

source§

fn format_fields<R: RecordFields>( &self, writer: &'writer mut dyn Write, fields: R ) -> Result

Format the provided fields to the provided writer, returning a result.
source§

fn add_fields( &self, current: &'writer mut String, fields: &Record<'_> ) -> Result

Record additional field(s) on an existing span. Read more

Auto Trait Implementations§

§

impl<'a, S, N> RefUnwindSafe for FmtContext<'a, S, N>where N: RefUnwindSafe, S: RefUnwindSafe,

§

impl<'a, S, N> Send for FmtContext<'a, S, N>where N: Sync, S: Sync,

§

impl<'a, S, N> Sync for FmtContext<'a, S, N>where N: Sync, S: Sync,

§

impl<'a, S, N> Unpin for FmtContext<'a, S, N>

§

impl<'a, S, N> UnwindSafe for FmtContext<'a, S, N>where N: RefUnwindSafe, S: RefUnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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