Struct tracing_futures::WithDispatch

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

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

Methods

impl WithDispatch<Runtime>

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

Spawn a future onto the Tokio runtime, in the context of this WithDispatch's trace dispatcher.

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 a future to completion on the Tokio runtime, in the context of this WithDispatch's trace dispatcher.

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) -> WithDispatch<TaskExecutor>

Return a handle to the runtime's executor, in the context of this WithDispatch's trace dispatcher.

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 WithDispatch<Runtime>

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

Spawn a future onto the single-threaded Tokio runtime, in the context of this WithDispatch's trace dispatcher.

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, 

Runs the provided future in the context of this WithDispatch's trace dispatcher, 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) -> WithDispatch<Handle>

Get a new handle to spawn futures on the single-threaded Tokio runtime, in the context of this WithDispatch's trace dispatcher.

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 the spawned futures are run in the context of the trace dispatcher.

impl<T> WithDispatch<T>

pub fn dispatch(&self) -> &Dispatch

Borrows the Dispatch that this type is instrumented by.

pub fn into_inner(self) -> T

Consumes the WithDispatch, returning the wrapped type.

Trait Implementations

impl<T: Clone> Clone for WithDispatch<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for WithDispatch<T>

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

Formats the value using the given formatter.

impl<T: Future> Future for WithDispatch<T>

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.

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

Block the current thread until this future is resolved.

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.

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.

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.

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

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

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

Execute another future after this one has resolved successfully.

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

Execute another future if this one resolves with an error.

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.

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.

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.

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

Same as join, but with more futures.

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
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

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
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>,
    E: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream.

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.

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.

fn fuse(self) -> Fuse<Self>

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

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.

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

Catches unwinding panics while polling the future.

fn shared(self) -> Shared<Self>

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

impl<T, F> Executor<F> for WithDispatch<T> where
    T: Executor<WithDispatch<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> Executor for WithDispatch<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.

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

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

impl<T, F> TypedExecutor<F> for WithDispatch<T> where
    T: TypedExecutor<WithDispatch<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.