Struct gloo_timers::callback::Interval

pub struct Interval { /* private fields */ }

A scheduled interval.

See Interval::new for scheduling new intervals.

Once scheduled, you can drop the Interval to clear it or forget to leak it. Once forgotten, the interval will keep running forever. This pattern is known as Resource Acquisition Is Initialization (RAII).

Implementations

impl Interval

pub fn new<F>(millis: u32, callback: F) -> Intervalwhere
    F: 'static + FnMut(),

Schedule an interval to invoke callback every millis milliseconds.

Example

use gloo_timers::callback::Interval;

let interval = Interval::new(1_000, move || {
    // Do something...
});

pub fn forget(self) -> JsValue

Forget this resource without clearing the interval.

Returns the identifier returned by the original setInterval call, and therefore you can still cancel the interval by calling clearInterval directly (perhaps via web_sys::clear_interval_with_handle).

Example

use gloo_timers::callback::Interval;

// We want to do stuff every second, indefinitely.
Interval::new(1_000, || {
    // Do stuff...
}).forget();

pub fn cancel(self) -> Closure<dyn FnMut()>

Cancel this interval so that the callback is no longer periodically invoked.

The scheduled callback is returned.

Example

use gloo_timers::callback::Interval;

let interval = Interval::new(1_000, || {
    // Do stuff...
});

// If we don't want this interval to run anymore, then cancel it.
if nevermind() {
    interval.cancel();
}

Trait Implementations

impl Debug for Interval

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

Formats the value using the given formatter.

impl Drop for Interval

fn drop(&mut self)

Disposes of the interval, dually cancelling this interval by calling clearInterval directly.