Struct gloo_timers::callback::Interval

#[must_use = "intervals cancel on drop; either call `forget` or `drop` explicitly"]
pub struct Interval { /* fields omitted */ }

A scheduled interval.

See Interval::new for scheduling new intervals.

Once scheduled, you can either cancel so that it ceases to fire or forget it so that it is un-cancel-able.

Methods

impl Interval

pub fn new<F>(millis: u32, callback: F) -> Interval where
    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) -> i32

Make this interval uncancel-able.

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 Drop for Interval

fn drop(&mut self)

Executes the destructor for this type.

impl Debug for Interval

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

Formats the value using the given formatter.