Timed

Struct Timed 

Source
pub struct Timed<F>
where F: Future,
{ /* private fields */ }
Expand description

Instrumentation to record the timing of a wrapped future.

The Timed wraps any future and records the inner future’s busy and idle time. The timing is returned together with the inner future’s output once it resolves ready.

§Examples

To wrap a future, use the timed function.


    let output = future_timing::timed(some_async_fn()).await;
    let (timing, future_output) = output.into_parts();

    do_something_with_output(future_output);

    assert!(!timing.idle().is_zero());
    assert!(!timing.busy().is_zero());

Trait Implementations§

Source§

impl<F> Future for Timed<F>
where F: Future,

Source§

type Output = TimingOutput<<F as Future>::Output>

The type of value produced on completion.
Source§

fn poll( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<TimingOutput<F::Output>>

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

impl<'__pin, F> Unpin for Timed<F>
where PinnedFieldsOf<__Origin<'__pin, F>>: Unpin, F: Future,

Auto Trait Implementations§

§

impl<F> Freeze for Timed<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for Timed<F>
where F: RefUnwindSafe,

§

impl<F> Send for Timed<F>
where F: Send,

§

impl<F> Sync for Timed<F>
where F: Sync,

§

impl<F> UnwindSafe for Timed<F>
where F: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<F> IntoFuture for F
where F: Future,

Source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
Source§

type IntoFuture = F

Which kind of future are we turning this into?
Source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.