Struct tracing_futures::Instrumented

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

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

Implementations

impl Instrumented<Runtime>

pub fn spawn<F>(&mut self, future: F) -> &mut Self where
    F: Future<Item = (), Error = ()> + Send + 'static, 

Spawn an instrumented future onto the Tokio runtime.

This spawns the given future onto the runtime's executor, usually a thread pool. The thread pool is then responsible for polling the future until it completes.

This method simply wraps a call to tokio::runtime::Runtime::spawn, instrumenting the spawned future beforehand.

pub fn block_on<F, R, E>(&mut self, future: F) -> Result<R, E> where
    F: Send + 'static + Future<Item = R, Error = E>,
    R: Send + 'static,
    E: Send + 'static, 

Run an instrumented future to completion on the Tokio runtime.

This runs the given future on the runtime, blocking until it is complete, and yielding its resolved result. Any tasks or timers which the future spawns internally will be executed on the runtime.

This method should not be called from an asynchronous context.

This method simply wraps a call to tokio::runtime::Runtime::block_on, instrumenting the spawned future beforehand.

Panics

This function panics if the executor is at capacity, if the provided future panics, or if called within an asynchronous execution context.

pub fn executor(&self) -> Instrumented<TaskExecutor>

Return an instrumented handle to the runtime's executor.

The returned handle can be used to spawn tasks that run on this runtime.

The instrumented handle functions identically to a tokio::runtime::TaskExecutor, but instruments the spawned futures prior to spawning them.

impl Instrumented<Runtime>

pub fn spawn<F>(&mut self, future: F) -> &mut Self where
    F: Future<Item = (), Error = ()> + 'static, 

Spawn an instrumented future onto the single-threaded Tokio runtime.

This method simply wraps a call to current_thread::Runtime::spawn, instrumenting the spawned future beforehand.

pub fn block_on<F, R, E>(&mut self, future: F) -> Result<R, E> where
    F: 'static + Future<Item = R, Error = E>,
    R: 'static,
    E: 'static, 

Instruments and runs the provided future, blocking the current thread until the future completes.

This function can be used to synchronously block the current thread until the provided future has resolved either successfully or with an error. The result of the future is then returned from this function call.

Note that this function will also execute any spawned futures on the current thread, but will not block until these other spawned futures have completed. Once the function returns, any uncompleted futures remain pending in the Runtime instance. These futures will not run until block_on or run is called again.

The caller is responsible for ensuring that other spawned futures complete execution by calling block_on or run.

This method simply wraps a call to current_thread::Runtime::block_on, instrumenting the spawned future beforehand.

Panics

This function panics if the executor is at capacity, if the provided future panics, or if called within an asynchronous execution context.

pub fn handle(&self) -> Instrumented<Handle>

Get a new instrumented handle to spawn futures on the single-threaded Tokio runtime

Different to the runtime itself, the handle can be sent to different threads.

The instrumented handle functions identically to a tokio::runtime::current_thread::Handle, but instruments the spawned futures prior to spawning them.

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>

This is supported on crate feature std-future only.

Get a pinned reference to the wrapped type.

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

This is supported on crate feature std-future only.

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.

pub 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> Executor for Instrumented<T> where
    T: Executor, 

fn spawn(
    &mut self,
    future: Box<dyn Future<Error = (), Item = ()> + Send + 'static>
) -> Result<(), SpawnError>

Spawns a future object to run on this executor.

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

Provides a best effort hint to whether or not spawn will succeed.

impl<T, F> Executor<F> for Instrumented<T> where
    T: Executor<Instrumented<F>>,
    F: Future<Item = (), Error = ()>, 

fn execute(&self, future: F) -> Result<(), ExecuteError<F>>

Spawns a future to run on this Executor, typically in the "background".

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

This is supported on crate feature std-future only.

type Output = T::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: Future> Future for Instrumented<T>

This is supported on crate feature futures-01 only.

type Item = T::Item

The type of value that this future will resolved with if it is successful.

type Error = T::Error

The type of error that this future will resolve with if it fails in a normal fashion.

fn poll(&mut self) -> Poll<Self::Item, Self::Error>

Query this future to see if its value has become available, registering interest if it is not.

pub fn wait(self) -> Result<Self::Item, Self::Error>

Block the current thread until this future is resolved.

pub fn map<F, U>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Item) -> U, 

Map this future's result to a different type, returning a new future of the resulting type.

pub fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> E, 

Map this future's error to a different error, returning a new future.

pub fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, 

Map this future's error to any error implementing From for this future's Error, returning a new future.

pub fn then<F, B>(self, f: F) -> Then<Self, B, F> where
    F: FnOnce(Result<Self::Item, Self::Error>) -> B,
    B: IntoFuture, 

Chain on a computation for when a future finished, passing the result of the future to the provided closure f.

pub fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where
    F: FnOnce(Self::Item) -> B,
    B: IntoFuture<Error = Self::Error>, 

Execute another future after this one has resolved successfully.

pub fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where
    F: FnOnce(Self::Error) -> B,
    B: IntoFuture<Item = Self::Item>, 

Execute another future if this one resolves with an error.

pub fn select<B>(self, other: B) -> Select<Self, <B as IntoFuture>::Future> where
    B: IntoFuture<Item = Self::Item, Error = Self::Error>, 

Waits for either one of two futures to complete.

pub fn select2<B>(self, other: B) -> Select2<Self, <B as IntoFuture>::Future> where
    B: IntoFuture, 

Waits for either one of two differently-typed futures to complete.

pub fn join<B>(self, other: B) -> Join<Self, <B as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>, 

Joins the result of two futures, waiting for them both to complete.

pub fn join3<B, C>(
    self,
    b: B,
    c: C
) -> Join3<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future> where
    C: IntoFuture<Error = Self::Error>,
    B: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

pub fn join4<B, C, D>(
    self,
    b: B,
    c: C,
    d: D
) -> Join4<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future> where
    C: IntoFuture<Error = Self::Error>,
    B: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

pub fn join5<B, C, D, E>(
    self,
    b: B,
    c: C,
    d: D,
    e: E
) -> Join5<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future, <E as IntoFuture>::Future> where
    C: IntoFuture<Error = Self::Error>,
    E: IntoFuture<Error = Self::Error>,
    B: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

pub fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream.

pub fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error: From<Self::Error>, 

Flatten the execution of this future when the successful result of this future is itself another future.

pub fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error == Self::Error, 

Flatten the execution of this future when the successful result of this future is a stream.

pub fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed.

pub fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnOnce(&Self::Item), 

Do something with the item of a future, passing it on.

pub fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, 

Catches unwinding panics while polling the future.

pub fn shared(self) -> Shared<Self>

Create a cloneable handle to this future where all handles will resolve to the same result.

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<T: Sink> Sink for Instrumented<T>

This is supported on crate feature futures-01 only.

type SinkItem = T::SinkItem

The type of value that the sink accepts.

type SinkError = T::SinkError

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

fn start_send(
    &mut self,
    item: Self::SinkItem
) -> StartSend<Self::SinkItem, Self::SinkError>

Begin the process of sending a value to the sink.

fn poll_complete(&mut self) -> Poll<(), Self::SinkError>

Flush all output from this sink, if necessary.

pub fn close(&mut self) -> Result<Async<()>, Self::SinkError>

A method to indicate that no more values will ever be pushed into this sink.

pub fn wait(self) -> Wait<Self>

Creates a new object which will produce a synchronous sink.

pub fn with<U, F, Fut>(self, f: F) -> With<Self, U, F, Fut> where
    F: FnMut(U) -> Fut,
    Fut: IntoFuture<Item = Self::SinkItem>,
    <Fut as IntoFuture>::Error: From<Self::SinkError>, 

Composes a function in front of the sink.

pub fn with_flat_map<U, F, St>(self, f: F) -> WithFlatMap<Self, U, F, St> where
    F: FnMut(U) -> St,
    St: Stream<Item = Self::SinkItem, Error = Self::SinkError>, 

Composes a function in front of the sink.

pub fn sink_map_err<F, E>(self, f: F) -> SinkMapErr<Self, F> where
    F: FnOnce(Self::SinkError) -> E, 

Transforms the error returned by the sink.

pub fn sink_from_err<E>(self) -> SinkFromErr<Self, E> where
    E: From<Self::SinkError>, 

Map this sink's error to any error implementing From for this sink's Error, returning a new sink.

pub fn buffer(self, amt: usize) -> Buffer<Self>

Adds a fixed-size buffer to the current sink.

pub fn fanout<S>(self, other: S) -> Fanout<Self, S> where
    S: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
    Self::SinkItem: Clone, 

Fanout items to multiple sinks.

pub fn flush(self) -> Flush<Self>

A future that completes when the sink has finished processing all pending requests.

pub fn send(self, item: Self::SinkItem) -> Send<Self>

A future that completes after the given item has been fully processed into the sink, including flushing.

pub fn send_all<S>(self, stream: S) -> SendAll<Self, S> where
    S: Stream<Item = Self::SinkItem>,
    Self::SinkError: From<<S as Stream>::Error>, 

A future that completes after the given stream has been fully processed into the sink, including flushing.

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

This is supported on crate features futures-03 and std-future only.

type Error = T::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>

This is supported on crate feature futures-01 only.

type Item = T::Item

The type of item this stream will yield on success.

type Error = T::Error

The type of error this stream may generate.

fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error>

Attempt to pull out the next value of this stream, returning None if the stream is finished.

pub fn wait(self) -> Wait<Self>

Creates an iterator which blocks the current thread until each item of this stream is resolved.

pub fn into_future(self) -> StreamFuture<Self>

Converts this stream into a Future.

pub fn map<U, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> U, 

Converts a stream of type T to a stream of type U.

pub fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
    F: FnMut(Self::Error) -> U, 

Converts a stream of error type T to a stream of error type U.

pub fn filter<F>(self, f: F) -> Filter<Self, F> where
    F: FnMut(&Self::Item) -> bool, 

Filters the values produced by this stream according to the provided predicate.

pub fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, 

Filters the values produced by this stream while simultaneously mapping them to a different type.

pub fn then<F, U>(self, f: F) -> Then<Self, F, U> where
    U: IntoFuture,
    F: FnMut(Result<Self::Item, Self::Error>) -> U, 

Chain on a computation for when a value is ready, passing the resulting item to the provided closure f.

pub fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U> where
    U: IntoFuture<Error = Self::Error>,
    F: FnMut(Self::Item) -> U, 

Chain on a computation for when a value is ready, passing the successful results to the provided closure f.

pub fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U> where
    U: IntoFuture<Item = Self::Item>,
    F: FnMut(Self::Error) -> U, 

Chain on a computation for when an error happens, passing the erroneous result to the provided closure f.

pub fn collect(self) -> Collect<Self>

Collect all of the values of this stream into a vector, returning a future representing the result of that computation.

pub fn concat2(self) -> Concat2<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator,
    Self::Item: Default, 

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result.

pub fn concat(self) -> Concat<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator, 

👎 Deprecated since 0.1.14:

please use Stream::concat2 instead

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result.

pub fn fold<F, T, Fut>(self, init: T, f: F) -> Fold<Self, F, Fut, T> where
    F: FnMut(T, Self::Item) -> Fut,
    Fut: IntoFuture<Item = T>,
    Self::Error: From<<Fut as IntoFuture>::Error>, 

Execute an accumulating computation over a stream, collecting all the values into one final result.

pub fn flatten(self) -> Flatten<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error: From<Self::Error>, 

Flattens a stream of streams into just one continuous stream.

pub fn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R> where
    R: IntoFuture<Item = bool, Error = Self::Error>,
    P: FnMut(&Self::Item) -> R, 

Skip elements on this stream while the predicate provided resolves to true.

pub fn take_while<P, R>(self, pred: P) -> TakeWhile<Self, P, R> where
    R: IntoFuture<Item = bool, Error = Self::Error>,
    P: FnMut(&Self::Item) -> R, 

Take elements from this stream while the predicate provided resolves to true.

pub fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U> where
    U: IntoFuture<Item = (), Error = Self::Error>,
    F: FnMut(Self::Item) -> U, 

Runs this stream to completion, executing the provided closure for each element on the stream.

pub fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, 

Map this stream's error to any error implementing From for this stream's Error, returning a new stream.

pub fn take(self, amt: u64) -> Take<Self>

Creates a new stream of at most amt items of the underlying stream.

pub fn skip(self, amt: u64) -> Skip<Self>

Creates a new stream which skips amt items of the underlying stream.

pub fn fuse(self) -> Fuse<Self>

Fuse a stream such that poll will never again be called once it has finished.

pub fn by_ref(&mut self) -> &mut Self

Borrows a stream, rather than consuming it.

pub fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, 

Catches unwinding panics while polling the stream.

pub fn buffered(self, amt: usize) -> Buffered<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error == Self::Error, 

An adaptor for creating a buffered list of pending futures.

pub fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error == Self::Error, 

An adaptor for creating a buffered list of pending futures (unordered).

pub fn merge<S>(self, other: S) -> Merge<Self, S> where
    S: Stream<Error = Self::Error>, 

👎 Deprecated:

functionality provided by select now

An adapter for merging the output of two streams.

pub fn zip<S>(self, other: S) -> Zip<Self, S> where
    S: Stream<Error = Self::Error>, 

An adapter for zipping two streams together.

pub fn chain<S>(self, other: S) -> Chain<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>, 

Adapter for chaining two stream.

pub fn peekable(self) -> Peekable<Self>

Creates a new stream which exposes a peek method.

pub fn chunks(self, capacity: usize) -> Chunks<Self>

An adaptor for chunking up items of the stream inside a vector.

pub fn select<S>(self, other: S) -> Select<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>, 

Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first.

pub fn forward<S>(self, sink: S) -> Forward<Self, S> where
    S: Sink<SinkItem = Self::Item>,
    Self::Error: From<<S as Sink>::SinkError>, 

A future that completes after the given stream has been fully processed into the sink, including flushing.

pub fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
    Self: Sink, 

Splits this Stream + Sink object into separate Stream and Sink objects.

pub fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), 

Do something with each item of this stream, afterwards passing it on.

pub fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
    F: FnMut(&Self::Error), 

Do something with the error of this stream, afterwards passing it on.

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

This is supported on crate features futures-03 and std-future only.

type Item = T::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.

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

Returns the bounds on the remaining length of the stream.

impl<T, F> TypedExecutor<F> for Instrumented<T> where
    T: TypedExecutor<Instrumented<F>>, 

fn spawn(&mut self, future: F) -> Result<(), SpawnError>

Spawns a future to run on this executor.

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

Provides a best effort hint to whether or not spawn will succeed.

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