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) -> Self

Create a new TimeoutJob with a timeout and a job.

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

where F: FnOnce(&mut Context) -> JsResult<JsValue> + '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) -> Self

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

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

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

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 cancelled(&self) -> bool

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

pub fn cancellation_token(&self) -> &CancellationToken

Returns the CancellationToken for this timeout job.

Trait Implementations

impl Debug for TimeoutJob

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

Formats the value using the given formatter.

impl Drop for TimeoutJob

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<TimeoutJob> for Job

fn from(job: TimeoutJob) -> Self

Converts to this type from the input type.