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

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

Struct 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<&Self>) -> Pin<&T>

Get a pinned reference to the wrapped type.

source

pub fn inner_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>

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> Clone for Instrumented<T>

source§

fn clone(&self) -> Instrumented<T>

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> Debug for Instrumented<T>

source§

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

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

impl<T> Drop for Instrumented<T>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

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

§

type Output = <T as Future>::Output

The type of value produced on completion.
source§

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::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> Freeze for Instrumented<T>
where T: Freeze,

§

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§

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<F> IntoFuture for F
where F: Future,

§

type Output = <F as Future>::Output

The output that the future will produce on completion.
§

type IntoFuture = F

Which kind of future are we turning this into?
source§

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

Creates a future from a value. 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
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.
source§

impl<T> WithCollector for T

source§

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

Available on crate feature std only.
Attaches the provided collector to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_collector(self) -> WithDispatch<Self>

Available on crate feature std only.
Attaches the current default collector to this type, returning a WithDispatch wrapper. Read more