Struct bevy::utils::tracing::Dispatch

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

Dispatch trace data to a Subscriber.

Implementations§

§

impl Dispatch

pub fn none() -> Dispatch

Returns a new Dispatch that discards events and spans.

pub fn new<S>(subscriber: S) -> Dispatch
where S: Subscriber + Send + Sync + 'static,

Returns a Dispatch that forwards to the given Subscriber.

pub fn downgrade(&self) -> WeakDispatch

Creates a WeakDispatch from this Dispatch.

A WeakDispatch is similar to a Dispatch, but it does not prevent the underlying Subscriber from being dropped. Instead, it only permits access while other references to the Subscriber exist. This is equivalent to the standard library’s Arc::downgrade method, but for Dispatch rather than Arc.

The primary use for creating a WeakDispatch is to allow a Subscriber to hold a cyclical reference to itself without creating a memory leak. See here for details.

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.

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.

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.

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.

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.

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.

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.

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.

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.

pub fn drop_span(&self, id: Id)

👎Deprecated since 0.1.2: use Dispatch::try_close instead

Notifies 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: The 
    try_close method is functionally identical, but returns
    true if the span is now closed. It should be used
    instead of this method.

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.

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.

pub fn is<T>(&self) -> bool
where T: Any,

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

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: Any,

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

Trait Implementations§

§

impl Clone for Dispatch

§

fn clone(&self) -> Dispatch

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl Debug for Dispatch

§

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

Formats the value using the given formatter. Read more
§

impl Default for Dispatch

§

fn default() -> Dispatch

Returns the current default dispatcher

§

impl<S> From<S> for Dispatch
where S: Subscriber + Send + Sync + 'static,

§

fn from(subscriber: S) -> Dispatch

Converts to this type from the input type.
§

impl<N, E, F, W> From<SubscriberBuilder<N, E, F, W>> for Dispatch
where N: for<'writer> FormatFields<'writer> + 'static, E: FormatEvent<Registry, N> + 'static, W: for<'writer> MakeWriter<'writer> + 'static, F: Layer<Layered<Layer<Registry, N, E, W>, Registry>> + Send + Sync + 'static, Layer<Registry, N, E, W>: Layer<Registry> + Send + Sync + 'static,

§

fn from(builder: SubscriberBuilder<N, E, F, W>) -> Dispatch

Converts to this type from the input type.

Auto Trait Implementations§

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
§

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

§

impl<T> FromWorld for T
where T: Default,

§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given World.
§

impl<T> Instrument for T

§

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

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

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.

§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

§

impl<T> NoneValue for T
where T: Default,

§

type NoneType = T

§

fn null_value() -> T

The none-equivalent value.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<T> SubscriberInitExt for T
where T: Into<Dispatch>,

§

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
§

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
§

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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

fn to_sample_(self) -> U

source§

impl<T, U> TryFrom<U> for T
where 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 T
where 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.
§

impl<T> TypeData for T
where T: 'static + Send + Sync + Clone,

§

fn clone_type_data(&self) -> Box<dyn TypeData>

§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ConditionalSend for T
where T: Send,

§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

§

impl<T> Settings for T
where T: 'static + Send + Sync,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,