Struct Timer

pub struct Timer<TS: ThreadSafety = DefaultThreadSafety> { /* private fields */ }

A future or stream that emits timer events.

This timer waits for a specific duration or interval to elapse before returning Poll::Ready. It uses the ControlFlow::WaitUntil mechanism to wait for the timer to fire.

This type is similar to the Timer type in the async-io crate. The main practical difference is that, on certain platforms, this Timer type may have marginally higher precision.

Implementations

impl<TS: ThreadSafety> Timer<TS>

pub fn never() -> Self

Create a new timer that will never fire.

pub fn will_fire(&self) -> bool

Returns true if this timer will eventually return Poll::Ready.

pub fn after(duration: Duration) -> Self

Create a timer that fires after the given duration.

pub fn at(deadline: Instant) -> Self

Create a timer that fires at the given time.

pub fn interval(period: Duration) -> Self

Create a timer that fires on an interval.

pub fn interval_at(start: Instant, period: Duration) -> Self

Create a timer that fires on an interval starting at the given time.

pub fn set_never(&mut self)

Set this timer to never fire.

pub fn set_after(&mut self, duration: Duration)

Set this timer to fire after the given duration.

pub fn set_at(&mut self, deadline: Instant)

Set this timer to fire at the given deadline.

pub fn set_interval(&mut self, period: Duration)

Set this timer to run at an interval.

pub fn set_interval_at(&mut self, start: Instant, period: Duration)

Set this timer to run on an interval starting at the given time.

Trait Implementations

impl<TS: ThreadSafety> Debug for Timer<TS>

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

Formats the value using the given formatter.

impl<TS: ThreadSafety> Drop for Timer<TS>

fn drop(&mut self)

Executes the destructor for this type.

impl<TS: ThreadSafety> Future for Timer<TS>

type Output = Instant

The type of value produced on completion.

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

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

impl<TS: ThreadSafety> Stream for Timer<TS>

type Item = Instant

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.

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

Returns the bounds on the remaining length of the stream.

impl<TS: ThreadSafety> Unpin for Timer<TS>