Struct async_timer::timed::Timed

#[must_use = "Timed does nothing unless polled"]
pub struct Timed<F, T = PlatformTimer> { /* fields omitted */ }

Limiter on time to wait for underlying Future

Methods

impl<F: Unpin> Timed<F>

pub fn platform_new(inner: F, timeout: Duration) -> Self

Creates new instance using Timer alias.

impl<F> Timed<F>

pub unsafe fn platform_new_unchecked(inner: F, timeout: Duration) -> Self

Creates new instance using Timer alias.

Unsafe version of platform_new that doesn't require Unpin.

impl<F: Unpin, T: Oneshot> Timed<F, T>

pub fn new(inner: F, timeout: Duration) -> Self

Creates new instance with specified timeout

Requires to specify Oneshot type (e.g. Timed::<oneshoot::Timer>::new())

impl<F, T: Oneshot> Timed<F, T>

pub unsafe fn new_unchecked(inner: F, timeout: Duration) -> Self

Creates new instance with specified timeout

Unsafe version of new that doesn't require Unpin.

Requires to specify Oneshot type (e.g. Timed::<oneshoot::Timer>::new())

Trait Implementations

impl<F: Future + Unpin, T: Oneshot> Unpin for Timed<F, T>

impl<F: Future, T: Oneshot> Future for Timed<F, T>

type Output = Result<F::Output, Expired<F, T>>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, ctx: &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.