Struct wasm_futures_executor::ThreadPool

pub struct ThreadPool { /* private fields */ }

A general-purpose thread pool for scheduling tasks that poll futures to completion.

The thread pool multiplexes any number of tasks onto a fixed number of worker threads.

This type is a clonable handle to the threadpool itself. Cloning it will only create a new reference, not a new threadpool.

The API follows futures_executor::ThreadPool.

Implementations

impl ThreadPool

pub async fn new(size: usize) -> Result<ThreadPool, JsValue>

Creates a new ThreadPool with the provided count of web workers. The returned future will resolve after all workers have spawned and are ready to accept work.

pub async fn max_threads() -> Result<Self, JsValue>

Creates a new ThreadPool with Navigator.hardwareConcurrency web workers.

pub fn spawn_ok<Fut>(&self, future: Fut) where
    Fut: Future<Output = ()> + Send + 'static, 

Spawns a task that polls the given future with output () to completion.

use wasm_futures_executor::ThreadPool;

let pool = ThreadPool::new().await.unwrap();

let future = async { /* ... */ };
pool.spawn_ok(future);

pub fn spawn<Fut>(
    &self,
    future: Fut
) -> impl Future<Output = Result<Fut::Output, Canceled>> + 'static where
    Fut: Future + Send + 'static,
    Fut::Output: Send + 'static, 

Spawns a task. This function returns a future which eventually resolves to the output of the computation. Note: The provided future is polled on the thread pool, no matter whether the returned future is polled or not.

Trait Implementations

impl Clone for ThreadPool

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for ThreadPool

fn drop(&mut self)

Executes the destructor for this type.

impl From<ThreadPool> for JsValue

fn from(value: ThreadPool) -> Self

Converts to this type from the input type.

impl FromWasmAbi for ThreadPool

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 ThreadPool

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 ThreadPool

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 ThreadPool

fn none() -> Self::Abi

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

impl RefFromWasmAbi for ThreadPool

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, ThreadPool>

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 ThreadPool

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, ThreadPool>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl WasmDescribe for ThreadPool

fn describe()