Struct TimeoutJob 

pub struct TimeoutJob { /* private fields */ }

An ECMAScript Job that runs after a certain amount of time.

This represents the HostEnqueueTimeoutJob operation from the specification.

Implementations

impl TimeoutJob

pub fn new(job: NativeJob, timeout_in_millis: u64) -> TimeoutJob

Create a new TimeoutJob with a timeout and a job.

pub fn recurring(job: NativeJob, timeout_in_millis: u64) -> TimeoutJob

Create a new TimeoutJob that is marked as recurring.

pub fn from_duration<F>(f: F, timeout: impl Into<JsDuration>) -> TimeoutJob

where F: FnOnce(&mut Context) -> Result<JsValue, JsError> + 'static,

Creates a new TimeoutJob from a closure and a timeout as std::time::Duration.

pub fn with_realm<F>(f: F, realm: Realm, timeout: Duration) -> TimeoutJob

where F: FnOnce(&mut Context) -> Result<JsValue, JsError> + 'static,

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

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

Calls the native job with the specified Context.

Note

If the native 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 timeout(&self) -> JsDuration

Returns the timeout value in milliseconds since epoch.

pub fn is_cancelled(&self) -> bool

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

pub fn is_recurring(&self) -> bool

Returns true if the job is recurring (meaning it happens regularly).

Trait Implementations

impl Debug for TimeoutJob

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

Formats the value using the given formatter.

impl From<TimeoutJob> for Job

fn from(job: TimeoutJob) -> Job

Converts to this type from the input type.