Struct Timer

pub struct Timer<T> { /* private fields */ }

Available on crate feature delay only.

Async wrapper for a non-blocking countdown timer.

Implementations

impl<T> Timer<T>

pub const fn new(counter: T) -> Self

Create a new timer from counter.

Trait Implementations

impl<T> DelayMs for Timer<T>

where T: CountDown + Cancel + Unpin, T::Time: From<MillisDurationU32>,

type Delay = u32

The type of duration to delay for.

type Error = <T as Cancel>::Error

The error returned on failure.

fn start(&mut self, ms: Self::Delay) -> Result<(), Self::Error>

Start a new delay.

fn cancel(&mut self) -> Result<(), Self::Error>

Attempt to cancel a delay in progress.

fn poll_delay_ms( self: Pin<&mut Self>, _cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Poll a delay of ms milliseconds. This function may wake the calling function rather than the waker.

fn poll_delay_ms_unpin( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

where Self: Unpin,

fn delay_ms(&mut self, ms: Self::Delay) -> DelayMsFuture<'_, Self>

where Self: Unpin,

Delay for ms milliseconds. Starts a new delay and returns a Future that completes when either the timer expires. The returned future also implements Stream if this delay is Periodic.