๐Ÿ›ˆ Note: This is pre-release documentation for the upcoming tracing 0.2.0 ecosystem.

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

Struct Collector

Source
pub struct Collector<N = DefaultFields, E = Format, F = LevelFilter, W = fn() -> Stdout> { /* private fields */ }
Available on crate features fmt and std only.
Expand description

A Collector that logs formatted representations of tracing events.

This consists of an inner Formatter wrapped in a subscriber that performs filtering.

Implementationsยง

Sourceยง

impl Collector

Source

pub const DEFAULT_MAX_LEVEL: LevelFilter = LevelFilter::INFO

The maximum verbosity level that is enabled by a Collector by default.

This can be overridden with the CollectorBuilder::with_max_level method.

Source

pub fn builder() -> CollectorBuilder

Returns a new CollectorBuilder for configuring a format subscriber.

Source

pub fn new() -> Self

Returns a new format subscriber with the default configuration.

Trait Implementationsยง

Sourceยง

impl<N, E, F, W> Collect for Collector<N, E, F, W>
where N: for<'writer> FormatFields<'writer> + 'static, E: FormatEvent<Registry, N> + 'static, F: Subscribe<Formatter<N, E, W>> + 'static, W: for<'writer> MakeWriter<'writer> + 'static, Layered<F, Formatter<N, E, W>>: Collect, Subscriber<Registry, N, E, W>: Subscribe<Registry>,

Sourceยง

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

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

fn enabled(&self, meta: &Metadata<'_>) -> bool

Returns true if a span or event with the specified metadata would be recorded. Read more
Sourceยง

fn new_span(&self, attrs: &Attributes<'_>) -> Id

Visit the construction of a new span, returning a new span ID for the span being constructed. Read more
Sourceยง

fn record(&self, span: &Id, values: &Record<'_>)

Record a set of values on a span. Read more
Sourceยง

fn record_follows_from(&self, span: &Id, follows: &Id)

Adds an indication that span follows from the span with the id follows. Read more
Sourceยง

fn event_enabled(&self, event: &Event<'_>) -> bool

Determine if an Event should be recorded. Read more
Sourceยง

fn event(&self, event: &Event<'_>)

Records that an Event has occurred. Read more
Sourceยง

fn enter(&self, id: &Id)

Records that a span has been entered. Read more
Sourceยง

fn exit(&self, id: &Id)

Records that a span has been exited. Read more
Sourceยง

fn current_span(&self) -> Current

Returns a type representing this collectorโ€™s view of the current span. Read more
Sourceยง

fn clone_span(&self, id: &Id) -> Id

Notifies the collector that a span ID has been cloned. Read more
Sourceยง

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

Notifies the collector that a span ID has been dropped, and returns true if there are now 0 IDs that refer to that span. Read more
Sourceยง

fn max_level_hint(&self) -> Option<LevelFilter> โ“˜

Returns the highest verbosity level that this Collector will enable, or None, if the collector does not implement level-based filtering or chooses not to implement this method. Read more
Sourceยง

unsafe fn downcast_raw(&self, id: TypeId) -> Option<NonNull<()>> โ“˜

If self is the same type as the provided TypeId, returns an untyped NonNull pointer to that type. Otherwise, returns None. Read more
Sourceยง

fn on_register_dispatch(&self, collector: &Dispatch)

Invoked when this collector becomes a Dispatch. Read more
Sourceยง

fn drop_span(&self, _id: Id)

๐Ÿ‘ŽDeprecated since 0.1.2: use Collector::try_close instead
This method is deprecated. Read more
Sourceยง

impl<N: Debug, E: Debug, F: Debug, W: Debug> Debug for Collector<N, E, F, W>

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl Default for Collector

Sourceยง

fn default() -> Self

Returns the โ€œdefault valueโ€ for a type. Read more
Sourceยง

impl<'a, N, E, F, W> LookupSpan<'a> for Collector<N, E, F, W>
where Layered<F, Formatter<N, E, W>>: LookupSpan<'a>,

Sourceยง

type Data = <Layered<F, Layered<Subscriber<Registry, N, E, W>, Registry>> as LookupSpan<'a>>::Data

The type of span data stored in this registry.
Sourceยง

fn span_data(&'a self, id: &Id) -> Option<Self::Data> โ“˜

Returns the SpanData for a given Id, if it exists. Read more
Sourceยง

fn span(&'a self, id: &Id) -> Option<SpanRef<'a, Self>> โ“˜
where Self: Sized,

Returns a SpanRef for the span with the given Id, if it exists. Read more
Sourceยง

fn register_filter(&mut self) -> FilterId

Available on crate feature registry only.

Auto Trait Implementationsยง

ยง

impl<N = DefaultFields, E = Format, F = LevelFilter, W = fn() -> Stdout> !Freeze for Collector<N, E, F, W>

ยง

impl<N, E, F, W> RefUnwindSafe for Collector<N, E, F, W>

ยง

impl<N, E, F, W> Send for Collector<N, E, F, W>
where F: Send, W: Send, N: Send, E: Send,

ยง

impl<N, E, F, W> Sync for Collector<N, E, F, W>
where F: Sync, W: Sync, N: Sync, E: Sync,

ยง

impl<N, E, F, W> Unpin for Collector<N, E, F, W>
where F: Unpin, W: Unpin, N: Unpin, E: Unpin,

ยง

impl<N = DefaultFields, E = Format, F = LevelFilter, W = fn() -> Stdout> !UnwindSafe for Collector<N, E, F, W>

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<C> CollectExt for C
where C: Collect,

Sourceยง

fn with<S>(self, subscriber: S) -> Layered<S, Self> โ“˜
where S: Subscribe<Self>, Self: Sized,

Wraps self with the provided subscriber.
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> SubscriberInitExt for T
where T: Into<Dispatch>,

Sourceยง

fn set_default(self) -> DefaultGuard

Available on crate feature std only.
Sets self as the default subscriber in the current scope, returning a guard that will unset it when dropped. Read more
Sourceยง

fn try_init(self) -> Result<(), TryInitError>

Attempts to set self as the global default subscriber in the current scope, returning an error if one is already set. Read more
Sourceยง

fn init(self)

Attempts to set self as the global default subscriber in the current scope, panicking if this fails. Read more
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