Struct IntervalJob 

pub struct IntervalJob { /* private fields */ }

An ECMAScript Job that runs at a certain interval of time.

This represents jobs enqueued by APIs such as setInterval.

Implementations

impl IntervalJob

pub fn new(job: NativeJobFn, interval_in_millis: u64) -> Self

Create a new IntervalJob with an interval and a job.

pub fn from_duration<F>(f: F, interval: impl Into<JsDuration>) -> Self

where F: Fn(&mut Context) -> JsResult<JsValue> + 'static,

Creates a new IntervalJob from a closure and an interval as std::time::Duration.

pub fn with_realm<F>(f: F, realm: Realm, interval: Duration) -> Self

where F: Fn(&mut Context) -> JsResult<JsValue> + 'static,

Creates a new TimeoutJob from a closure, an interval, and an execution realm.

pub fn call(&self, context: &mut Context) -> JsResult<JsValue>

Calls the interval job with the specified Context.

Note

If the interval job has an execution realm defined, this sets the running execution context to the realm’s before calling the inner closure, and resets it after execution.

pub fn interval(&self) -> JsDuration

Returns the interval value in milliseconds.

pub fn cancelled(&self) -> bool

Returns true if the interval job was cancelled, and its execution can be skipped.

pub fn cancellation_token(&self) -> &CancellationToken

Returns the CancellationToken for this interval job.

Trait Implementations

impl Debug for IntervalJob

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

Formats the value using the given formatter.

impl Drop for IntervalJob

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl From<IntervalJob> for Job

fn from(job: IntervalJob) -> Self

Converts to this type from the input type.