Struct tracing_futures::Instrumented

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

A future, stream, sink, or executor that has been instrumented with a tracing span.

Implementations

impl<T> Instrumented<T>

pub fn span(&self) -> &Span

Borrows the Span that this type is instrumented by.

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

Mutably borrows the Span that this type is instrumented by.

pub fn inner(&self) -> &T

Borrows the wrapped type.

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

Mutably borrows the wrapped type.

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

Get a pinned reference to the wrapped type.

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

Get a pinned mutable reference to the wrapped type.

pub fn into_inner(self) -> T

Consumes the Instrumented, returning the wrapped type.

Note that this drops the span.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

type Output = <T as Future>::Output

The type of value produced on completion.

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.

impl<T> LocalSpawn for Instrumented<T>

where T: LocalSpawn,

fn spawn_local_obj( &self, future: LocalFutureObj<'static, ()> ) -> Result<(), SpawnError>

Spawns a future that will be run to completion.

Errors

The executor may be unable to spawn tasks. Spawn errors should represent relatively rare scenarios, such as the executor having been shut down so that it is no longer able to accept tasks.

fn status_local(&self) -> Result<(), SpawnError>

Determines whether the executor is able to spawn new tasks.

This method will return Ok when the executor is likely (but not guaranteed) to accept a subsequent spawn attempt. Likewise, an Err return means that spawn is likely, but not guaranteed, to yield an error.

impl<I, T> Sink<I> for Instrumented<T>

where T: Sink<I>,

type Error = <T as Sink<I>>::Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<T> Spawn for Instrumented<T>

where T: Spawn,

fn spawn_obj(&self, future: FutureObj<'static, ()>) -> Result<(), SpawnError>

Spawns a future that will be run to completion.

Errors

The executor may be unable to spawn tasks. Spawn errors should represent relatively rare scenarios, such as the executor having been shut down so that it is no longer able to accept tasks.

fn status(&self) -> Result<(), SpawnError>

Determines whether the executor is able to spawn new tasks.

This method will return Ok when the executor is likely (but not guaranteed) to accept a subsequent spawn attempt. Likewise, an Err return means that spawn is likely, but not guaranteed, to yield an error.

impl<T: Stream> Stream for Instrumented<T>

type Item = <T as Stream>::Item

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'pin, T> Unpin for Instrumented<T>

where __Instrumented<'pin, T>: Unpin,