Struct basalt::interval::Interval

pub struct Interval { /* private fields */ }

The main struct for the interval system.

Accessed via basalt.interval_ref() or basalt.interval().

Implementations

impl Interval

pub fn do_every<F: FnMut(Option<Duration>) -> IntvlHookCtrl + Send + 'static>(
    &self,
    every: Duration,
    delay: Option<Duration>,
    method: F
) -> IntvlHookID

Call the method at provided internval.

Takes a Fn(last_call: Option<Duration>) -> IntvlHookCtrl.

• last_call: Duration since the last method was called.
• delay: is the duration that has to elapsed after Interval::start(...) before the hook method is called.
• IntvlHookCtrl: controls how the hook is handled after the method is called.

Notes

• Hooks are paused to begin with. They must be started with Interval::start(...).
• last_call will only be Some if the method is called continuously. Returning InputHookCtrl::Pause or using Interval::pause(...) will cause the next call to be None.

pub fn pause(&self, id: IntvlHookID)

Pause a hook.

Notes

• If hook doesn’t exist this does nothing.

pub fn start(&self, id: IntvlHookID)

Start a hook.

Notes

• If hook doesn’t exist this does nothing.

pub fn remove(&self, id: IntvlHookID)

Remove a hook.

Notes

• If hook doesn’t exist this does nothing.