Struct madsim::time::Interval

pub struct Interval { /* private fields */ }

Interval returned by interval and interval_at.

Implementations

impl Interval

pub async fn tick(&mut self) -> Instant

Completes when the next instant in the interval has been reached.

pub fn poll_tick(&mut self, cx: &mut Context<'_>) -> Poll<Instant>

Polls for the next instant in the interval to be reached.

This method can return the following values:

• Poll::Pending if the next instant has not yet been reached.
• Poll::Ready(instant) if the next instant has been reached.

When this method returns Poll::Pending, the current task is scheduled to receive a wakeup when the instant has elapsed. Note that on multiple calls to poll_tick, only the Waker from the Context passed to the most recent call is scheduled to receive a wakeup.

pub fn reset(&mut self)

Resets the interval to complete one period after the current time.

This method ignores MissedTickBehavior strategy.

pub fn missed_tick_behavior(&self) -> MissedTickBehavior

Returns the MissedTickBehavior strategy currently being used.

pub fn set_missed_tick_behavior(&mut self, behavior: MissedTickBehavior)

Sets the MissedTickBehavior strategy that should be used.

pub fn period(&self) -> Duration

Returns the period of the interval.

Trait Implementations

impl Debug for Interval

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

Formats the value using the given formatter.