Struct Schedule

pub struct Schedule<'a> { /* private fields */ }

Timer’s schedule

If initial timeout is not configured, then it is set to interval timeout

Implementations

impl<'a> Schedule<'a>

pub const fn initial(self, timeout: Duration) -> Self

Sets initial timeout to fire timer.

pub const fn interval(self, timeout: Duration) -> Self

Sets timeout interval to run periodically after initial has been fired

Note that if timeout is zero behavior depends on underlying OS API. But most often than note it will fire immediately.

pub fn schedule(&self) -> bool

Schedules timer execution, using provided settings.

Returns true if successfully set, otherwise on error returns false