[][src]Struct tracing_futures::WithDispatch

pub struct WithDispatch<T> { /* fields omitted */ }
This is supported on feature="std" only.

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

Methods

impl WithDispatch<Runtime>[src]

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

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, 
[src]

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>[src]

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>[src]

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

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, 
[src]

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>[src]

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>[src]

pub fn with_dispatch<U>(&self, inner: U) -> WithDispatch<U>[src]

Wrap a future, stream, sink or executor with the same subscriber as this WithDispatch.

pub fn dispatch(&self) -> &Dispatch[src]

Borrows the Dispatch that this type is instrumented by.

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

This is supported on feature="std-future" only.

Get a pinned reference to the wrapped type.

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

This is supported on feature="std-future" only.

Get a pinned mutable reference to the wrapped type.

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 into_inner(self) -> T[src]

Consumes the WithDispatch, returning the wrapped type.

Trait Implementations

impl<T: Clone> Clone for WithDispatch<T>[src]

impl<T: Debug> Debug for WithDispatch<T>[src]

impl<T, F> Executor<F> for WithDispatch<T> where
    T: Executor<WithDispatch<F>>,
    F: Future<Item = (), Error = ()>, 
[src]

impl<T> Executor for WithDispatch<T> where
    T: Executor
[src]

impl<T: Future> Future for WithDispatch<T>[src]

type Output = T::Output

The type of value produced on completion.

impl<T: Future> Future for WithDispatch<T>[src]

type Item = T::Item

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

type Error = T::Error

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

impl<T> LocalSpawn for WithDispatch<T> where
    T: LocalSpawn
[src]

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

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>[src]

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> PinnedDrop for WithDispatch<T>[src]

impl<T> Spawn for WithDispatch<T> where
    T: Spawn
[src]

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

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>[src]

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, F> TypedExecutor<F> for WithDispatch<T> where
    T: TypedExecutor<WithDispatch<F>>, 
[src]

impl<'pin, T> Unpin for WithDispatch<T> where
    __WithDispatch<'pin, T>: Unpin
[src]

Auto Trait Implementations

impl<T> !RefUnwindSafe for WithDispatch<T>

impl<T> Send for WithDispatch<T> where
    T: Send

impl<T> Sync for WithDispatch<T> where
    T: Sync

impl<T> !UnwindSafe for WithDispatch<T>

Blanket Implementations

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

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

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

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

impl<T> FutureExt for T where
    T: Future + ?Sized
[src]

impl<T> FutureExt for T where
    T: Future + ?Sized
[src]

impl<T> Instrument for T[src]

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

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

type Future = F

The future that this type can be converted into.

type Item = <F as Future>::Item

The item that the future may resolve with.

type Error = <F as Future>::Error

The error that the future may resolve with.

impl<Sp> LocalSpawnExt for Sp where
    Sp: LocalSpawn + ?Sized
[src]

impl<Sp> SpawnExt for Sp where
    Sp: Spawn + ?Sized
[src]

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

type Owned = T

The resulting type after obtaining ownership.

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.

impl<F, T, E> TryFuture for F where
    F: Future<Output = Result<T, E>> + ?Sized
[src]

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

impl<Fut> TryFutureExt for Fut where
    Fut: TryFuture + ?Sized
[src]

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.

impl<T> WithSubscriber for T[src]