Struct web_worker::WorkerPool

pub struct WorkerPool { /* fields omitted */ }

The WorkerPool. This is a special type of thread pool that works on wasm and provide a way to run work they way rayon does it.

Implementations

impl WorkerPool

pub fn new(initial: usize) -> Result<WorkerPool, JsValue>

Creates a new WorkerPool which immediately creates initial workers.

The pool created here can be used over a long period of time, and it will be initially primed with initial workers. Currently workers are never released or gc'd until the whole pool is destroyed.

Errors

Returns any error that may happen while a JS web worker is created and a message is sent to it.

impl WorkerPool

pub fn run(&self, f: impl FnOnce() + Send + 'static) -> Result<(), JsValue>

Executes f in a web worker.

This pool manages a set of web workers to draw from, and f will be spawned quickly into one if the worker is idle. If no idle workers are available then a new web worker will be spawned.

Once f returns the worker assigned to f is automatically reclaimed by this WorkerPool. This method provides no method of learning when f completes, and for that you'll need to use run_notify.

Errors

If an error happens while spawning a web worker or sending a message to a web worker, that error is returned.

pub fn run_notify<T>(
    &self,
    f: impl FnOnce() -> T + Send + 'static
) -> Result<impl Future<Item = T, Error = JsValue> + 'static, JsValue> where
    T: Send + 'static, 

Executes the closure f in a web worker, returning a future of the value that f produces.

This method is the same as run execept that it allows recovering the return value of the closure f in a nonblocking fashion with the future returned.

Errors

If an error happens while spawning a web worker or sending a message to a web worker, that error is returned.

Trait Implementations

impl From<WorkerPool> for JsValue

fn from(value: WorkerPool) -> Self

Performs the conversion.

impl FromWasmAbi for WorkerPool

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for WorkerPool

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl OptionFromWasmAbi for WorkerPool

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a "none" instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for WorkerPool

fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for WorkerPool

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, WorkerPool>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don't persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for WorkerPool

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, WorkerPool>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl WasmDescribe for WorkerPool

fn describe()