Struct bevy::utils::tracing::instrument::Instrumented

source · [−]

pub struct Instrumented<T> { /* private fields */ }

Expand description

A Future that has been instrumented with a tracing Span.

This type is returned by the Instrument extension trait. See that trait’s documentation for details.

Implementations

source

impl<T> Instrumented<T>

source

pub fn span(&self) -> &Span

Borrows the Span that this type is instrumented by.

source

pub fn span_mut(&mut self) -> &mut Span

Mutably borrows the Span that this type is instrumented by.

source

pub fn inner(&self) -> &T

Borrows the wrapped type.

source

pub fn inner_mut(&mut self) -> &mut T

Mutably borrows the wrapped type.

source

pub fn inner_pin_ref(self: Pin<&Instrumented<T>>) -> Pin<&T>ⓘNotable traits for Pin`impl Future for Pin where P: DerefMut, ::Target: Future, type Output = <::Target as Future>::Output;`

Get a pinned reference to the wrapped type.

source

pub fn inner_pin_mut(self: Pin<&mut Instrumented<T>>) -> Pin<&mut T>ⓘNotable traits for Pin`impl Future for Pin where P: DerefMut, ::Target: Future, type Output = <::Target as Future>::Output;`

Get a pinned mutable reference to the wrapped type.

source

pub fn into_inner(self) -> T

Consumes the Instrumented, returning the wrapped type.

Note that this drops the span.

Trait Implementations

source

impl<T> Clone for Instrumented<T> where
T: Clone,

source

pub fn clone(&self) -> Instrumented<T>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

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

source

impl<T> Debug for Instrumented<T> where
T: Debug,

source

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

Formats the value using the given formatter. Read more

source

impl<T> Future for Instrumented<T> where
T: Future,

type Output = <T as Future>::Output

The type of value produced on completion.

source

pub fn poll(
self: Pin<&mut Instrumented<T>>,
cx: &mut Context<'_>
) -> Poll<<Instrumented<T> as Future>::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

source

impl<'pin, T> Unpin for Instrumented<T> where
Origin<'__pin, T>: Unpin,

Auto Trait Implementations

impl<T> !RefUnwindSafe for Instrumented<T>

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

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

impl<T> !UnwindSafe for Instrumented<T>

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

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

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<I, A>`impl<I, A> Iterator for Box<I, A> where I: Iterator + ?Sized, A: Allocator, type Item = ::Item;impl<F, A> Future for Box<F, A> where F: Future + Unpin + ?Sized, A: Allocator + 'static, type Output = <F as Future>::Output;`

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. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

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

pub 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. Read more

pub 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. Read more

impl<T> Downcast<T> for T

pub fn downcast(&self) -> &T

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

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

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

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

impl<F> FutureExt for F where
F: Future + ?Sized,

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,

A convenience for calling Future::poll() on !Unpin types.

fn or<F>(self, other: F) -> Or<Self, F>ⓘNotable traits for Or<F1, F2>`impl<T, F1, F2> Future for Or<F1, F2> where F1: Future<Output = T>, F2: Future<Output = T>, type Output = T;` where
F: Future<Output = Self::Output>,

Returns the result of self or other future, preferring self if both are ready. Read more

fn race<F>(self, other: F) -> Race<Self, F>ⓘNotable traits for Race<F1, F2>`impl<T, F1, F2> Future for Race<F1, F2> where F1: Future<Output = T>, F2: Future<Output = T>, type Output = T;` where
F: Future<Output = Self::Output>,

Returns the result of self or other future, with no preference if both are ready. Read more

fn catch_unwind(self) -> CatchUnwind<Self>ⓘNotable traits for CatchUnwind<F>`impl<F> Future for CatchUnwind<F> where F: Future + UnwindSafe, type Output = Result<<F as Future>::Output, Box<dyn Any + Send + 'static, Global>>;` where
Self: UnwindSafe,

Catches panics while polling the future. Read more

fn boxed<'a>(
 self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>>ⓘNotable traits for Pin`impl Future for Pin where P: DerefMut, ::Target: Future, type Output = <::Target as Future>::Output;` where
 Self: 'a + Send,

Boxes the future and changes its type to dyn Future + Send + 'a. Read more

fn boxed_local<'a>(
 self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>>ⓘNotable traits for Pin`impl Future for Pin where P: DerefMut, ::Target: Future, type Output = <::Target as Future>::Output;` where
 Self: 'a,

Boxes the future and changes its type to dyn Future + 'a. Read more

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

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

source

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

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

source

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<F> IntoFuture for F where
F: Future,

type Output = <F as Future>::Output

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

type Future = F

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

source

pub fn into_future(self) -> <F as IntoFuture>::Future

🔬 This is a nightly-only experimental API. (into_future)

Creates a future from a value.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized,

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

pub fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>

Poll this TryFuture as if it were a Future. Read more

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>ⓘNotable traits for Box<I, A>`impl<I, A> Iterator for Box<I, A> where I: Iterator + ?Sized, A: Allocator, type Item = ::Item;impl<F, A> Future for Box<F, A> where F: Future + Unpin + ?Sized, A: Allocator + 'static, type Output = <F as Future>::Output;`

impl<T> Upcast<T> for T

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

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

pub fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` 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>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

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

Struct bevy::utils::tracing::instrument::Instrumented

Implementations

impl<T> Instrumented<T>

pub fn span(&self) -> &Span

pub fn span_mut(&mut self) -> &mut Span

pub fn inner(&self) -> &T

pub fn inner_mut(&mut self) -> &mut T

pub fn inner_pin_ref(self: Pin<&Instrumented<T>>) -> Pin<&T>ⓘNotable traits for Pin<P>impl<P> Future for Pin<P> where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;

pub fn inner_pin_mut(self: Pin<&mut Instrumented<T>>) -> Pin<&mut T>ⓘNotable traits for Pin<P>impl<P> Future for Pin<P> where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;

pub fn into_inner(self) -> T

Trait Implementations

impl<T> Clone for Instrumented<T> where T: Clone,

pub fn clone(&self) -> Instrumented<T>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

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

impl<T> Debug for Instrumented<T> where T: Debug,

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

impl<T> Future for Instrumented<T> where T: Future,

type Output = <T as Future>::Output

pub fn poll( self: Pin<&mut Instrumented<T>>, cx: &mut Context<'_>) -> Poll<<Instrumented<T> as Future>::Output>

impl<'__pin, T> Unpin for Instrumented<T> where __Origin<'__pin, T>: Unpin,

Auto Trait Implementations

impl<T> !RefUnwindSafe for Instrumented<T>

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

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

impl<T> !UnwindSafe for Instrumented<T>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

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

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

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

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

impl<T> Downcast<T> for T

pub fn downcast(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<F> FutureExt for F where F: Future + ?Sized,

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where Self: Unpin,

fn or<F>(self, other: F) -> Or<Self, F>ⓘNotable traits for Or<F1, F2>impl<T, F1, F2> Future for Or<F1, F2> where F1: Future<Output = T>, F2: Future<Output = T>, type Output = T; where F: Future<Output = Self::Output>,

fn race<F>(self, other: F) -> Race<Self, F>ⓘNotable traits for Race<F1, F2>impl<T, F1, F2> Future for Race<F1, F2> where F1: Future<Output = T>, F2: Future<Output = T>, type Output = T; where F: Future<Output = Self::Output>,

fn catch_unwind(self) -> CatchUnwind<Self>ⓘNotable traits for CatchUnwind<F>impl<F> Future for CatchUnwind<F> where F: Future + UnwindSafe, type Output = Result<<F as Future>::Output, Box<dyn Any + Send + 'static, Global>>; where Self: UnwindSafe,

fn boxed<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>>ⓘNotable traits for Pin<P>impl<P> Future for Pin<P> where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output; where Self: 'a + Send,

fn boxed_local<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>>ⓘNotable traits for Pin<P>impl<P> Future for Pin<P> where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output; where Self: 'a,

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

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

pub fn into(self) -> U

impl<F> IntoFuture for F where F: Future,

type Output = <F as Future>::Output

type Future = F

pub fn into_future(self) -> <F as IntoFuture>::Future

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

impl<F, T, E> TryFuture for F where F: Future<Output = Result<T, E>> + ?Sized,

type Ok = T

type Error = E

pub fn try_poll( self: Pin<&mut F>, cx: &mut Context<'_>) -> Poll<<F as Future>::Output>

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

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

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

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

impl<T> Upcast<T> for T

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

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

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output; where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;

pub fn inner_pin_ref(self: Pin<&Instrumented<T>>) -> Pin<&T>ⓘNotable traits for Pin<P>`impl<P> Future for Pin<P> where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;`

pub fn inner_pin_mut(self: Pin<&mut Instrumented<T>>) -> Pin<&mut T>ⓘNotable traits for Pin<P>`impl<P> Future for Pin<P> where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;`

impl<T> Clone for Instrumented<T> where
T: Clone,

pub fn clone(&self) -> Instrumented<T>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

impl<T> Debug for Instrumented<T> where
T: Debug,

impl<T> Future for Instrumented<T> where
T: Future,

pub fn poll(
self: Pin<&mut Instrumented<T>>,
cx: &mut Context<'_>
) -> Poll<<Instrumented<T> as Future>::Output>

impl<'pin, T> Unpin for Instrumented<T> where
Origin<'__pin, T>: Unpin,

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

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

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

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

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

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

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

impl<F> FutureExt for F where
F: Future + ?Sized,

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,

fn or<F>(self, other: F) -> Or<Self, F>ⓘNotable traits for Or<F1, F2>`impl<T, F1, F2> Future for Or<F1, F2> where F1: Future<Output = T>, F2: Future<Output = T>, type Output = T;` where
F: Future<Output = Self::Output>,

fn race<F>(self, other: F) -> Race<Self, F>ⓘNotable traits for Race<F1, F2>`impl<T, F1, F2> Future for Race<F1, F2> where F1: Future<Output = T>, F2: Future<Output = T>, type Output = T;` where
F: Future<Output = Self::Output>,

fn catch_unwind(self) -> CatchUnwind<Self>ⓘNotable traits for CatchUnwind<F>`impl<F> Future for CatchUnwind<F> where F: Future + UnwindSafe, type Output = Result<<F as Future>::Output, Box<dyn Any + Send + 'static, Global>>;` where
Self: UnwindSafe,

fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>>ⓘNotable traits for Pin<P>`impl<P> Future for Pin<P> where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;` where
Self: 'a + Send,

fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>>ⓘNotable traits for Pin<P>`impl<P> Future for Pin<P> where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;` where
Self: 'a,

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

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

impl<F> IntoFuture for F where
F: Future,

impl<T> ToOwned for T where
T: Clone,

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

impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized,

pub fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` where
S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

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