# tracing::instrument::Instrumented - Rust
API documentation for the Rust `Instrumented` struct in crate `tracing`.
Keywords: rust, rustlang, rust-lang, Instrumented

# Struct tracing::instrument::Instrumented [−] [src]

    #[must_use = "futures do nothing unless you `.await` or poll them"]pub struct Instrumented<T> { /* fields omitted */ }

A future that has been instrumented with a `tracing` span.

## Implementations

### `impl<T> Instrumented<T>` [src]

#### `pub fn span(&self) -> &Span` [src]

Borrows the `Span` that this type is instrumented by.

#### `pub fn span_mut(&mut self) -> &mut Span` [src]

Mutably borrows the `Span` that this type is instrumented by.

#### `pub fn inner(&self) -> &T` [src]

Borrows the wrapped type.

#### `pub fn inner_mut(&mut self) -> &mut T` [src]

Mutably borrows the wrapped type.

#### `pub fn inner_pin_ref(self: Pin<&Self>) -> Pin<&T>` [src]

Get a pinned reference to the wrapped type.

#### `pub fn inner_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>` [src]

Get a pinned mutable reference to the wrapped type.

#### `pub fn into_inner(self) -> T` [src]

Consumes the `Instrumented`, returning the wrapped type.

Note that this drops the span.

## Trait Implementations

### `impl<T: Clone> Clone for Instrumented<T>` [src]

#### `fn clone(&self) -> Instrumented<T>ⓘ

### Notable traits for Instrumented<T>

`impl<T: Future> Future for Instrumented<T> type Output = T::Output;`
` [src]

Returns a copy of the value. Read more

#### `pub fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl<T: Debug> Debug for Instrumented<T>` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl<T: Future> Future for Instrumented<T>` [src]

#### `type Output = T::Output`

The type of value produced on completion.

#### `fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>` [src]

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

### `impl<'__pin, T> Unpin for Instrumented<T> where
__Origin<'__pin, T>: Unpin,` [src]

## Auto Trait Implementations

### `impl<T> !RefUnwindSafe for Instrumented<T>` [src]

### `impl<T> Send for Instrumented<T> where
T: Send,` [src]

### `impl<T> Sync for Instrumented<T> where
T: Sync,` [src]

### `impl<T> !UnwindSafe for Instrumented<T>` [src]

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T> Instrument for T` [src]

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

### Notable traits for Instrumented<T>

`impl<T: Future> Future for Instrumented<T> type Output = T::Output;`
` [src]

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

#### `fn in_current_span(self) -> Instrumented<Self>ⓘ

### Notable traits for Instrumented<T>

`impl<T: Future> Future for Instrumented<T> type Output = T::Output;`
` [src]

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

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<F> IntoFuture for F where
F: Future,` [src]

#### `type Output = <F as Future>::Output`

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

The output that the future will produce on completion.

#### `type Future = F`

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

Which kind of future are we turning this into?

#### `pub fn into_future(self) -> <F as IntoFuture>::Future` [src]

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

Creates a future from a value.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T` [src]

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

#### `pub fn clone_into(&self, target: &mut T)` [src]

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

recently added

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

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.