Struct IntervalHandle 

pub struct IntervalHandle { /* private fields */ }

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.

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

impl IntervalHandle

pub fn new(interval_id: i32) -> IntervalHandle

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 Copy for IntervalHandle

impl Debug for IntervalHandle

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

Formats the value using the given formatter.

impl Default for IntervalHandle

fn default() -> IntervalHandle

Returns the “default value” for a type.

impl Eq for IntervalHandle

impl Hash for IntervalHandle

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for IntervalHandle

fn cmp(&self, other: &IntervalHandle) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for IntervalHandle

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

Tests for self and other values to be equal, and is used by ==.

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 PartialOrd for IntervalHandle

fn partial_cmp(&self, other: &IntervalHandle) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for IntervalHandle