Struct IntervalHandle 

pub struct IntervalHandle {
    pub interval_id: i32,
}

A handle to a browser interval timer created by use_interval.

Stores the numeric interval ID returned by window.setInterval so the timer can be cancelled later via clear_interval.

Fields

interval_id: i32

The interval ID assigned by the browser.

Implementations

impl IntervalHandle

Implementation of interval handle lifecycle management.

pub fn clear(&self)

Cancels the associated browser interval timer.

Calls window.clearInterval with the stored interval ID. After calling this method the interval callback will no longer fire.

Panics

Panics if window() is unavailable on the current platform.

impl IntervalHandle

pub fn get_interval_id(&self) -> i32

pub fn set_interval_id(&mut self, val: i32) -> &mut Self

pub fn get_mut_interval_id(&mut self) -> &mut i32

impl IntervalHandle

pub fn new(interval_id: i32) -> Self

Trait Implementations

impl Clone for IntervalHandle

fn clone(&self) -> IntervalHandle

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PartialEq for IntervalHandle

Compares interval handles by their interval ID.

fn eq(&self, other: &Self) -> bool

Compares two interval handles for equality by their interval IDs.

Arguments

• &Self - The first interval handle.
• &Self - The second interval handle.

Returns

• bool - true if both handles have the same interval ID.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for IntervalHandle