Skip to main content

Job

Struct Job 

Source
pub struct Job { /* private fields */ }
Expand description

A background job whose items run between browser frames.

Implementations§

Source§

impl Job

Source

pub fn new() -> Self

Create an empty, completed job.

Source

pub fn set( &mut self, count: u64, f: impl Fn(usize, &JobCtl) + Send + Sync + 'static, ) -> bool

Replace a completed job’s work; item counts must fit wasm32 address space.

Source

pub fn set_count(&mut self, count: u64) -> bool

Replace only the item count after completion.

Source

pub fn start(&self) -> bool

Queue the job; execution begins during the next host step.

Source

pub fn wait(&self) -> Result<(), Cancelled>

Finish remaining work synchronously when a caller explicitly waits.

Source

pub fn cancel(&self)

Request cancellation at the next item boundary.

Source

pub fn done(&self) -> bool

Whether the job has completed or has not started.

Source

pub fn items_done(&self) -> u64

Completed item count.

Source

pub fn count(&self) -> u64

Total item count.

Trait Implementations§

Source§

impl Default for Job

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Drop for Job

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Job

§

impl !UnwindSafe for Job

§

impl Forget for Job

§

impl Freeze for Job

§

impl Send for Job

§

impl Sync for Job

§

impl Unpin for Job

§

impl UnsafeUnpin for Job

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.