Struct wasm_thread::Builder

pub struct Builder { /* private fields */ }

Thread factory, which can be used in order to configure the properties of a new thread.

Implementations

impl Builder

pub fn spawn_scoped<'scope, 'env, F, T>( self, scope: &'scope Scope<'scope, 'env>, f: F ) -> Result<ScopedJoinHandle<'scope, T>>

where F: FnOnce() -> T + Send + 'scope, T: Send + 'scope,

Spawns a new scoped thread using the settings set through this Builder.

Unlike Scope::spawn, this method yields an std::io::Result to capture any failure to create the thread at the OS level.

impl Builder

pub fn new() -> Builder

Creates a builder inheriting global configuration options set by Self::set_default.

pub fn empty() -> Builder

Creates a builder without inheriting global options set by Self::set_default.

pub fn set_default(self)

Sets current values as global default for all new builders created with Builder::new or Builder::default.

pub fn prefix(self, prefix: String) -> Builder

Sets the prefix of the thread.

pub fn worker_script_url(self, worker_script_url: String) -> Builder

pub fn name(self, name: String) -> Builder

Sets the name of the thread.

If not set, the default name is autogenerated.

pub fn stack_size(self, size: usize) -> Builder

Sets the size of the stack (in bytes) for the new thread.

Warning

This is currently not supported by wasm, but provided for API consistency with std::thread.

pub fn wasm_bindgen_shim_url(self, url: String) -> Builder

Sets the URL of wasm_bindgen generated shim script.

pub fn spawn<F, T>(self, f: F) -> Result<JoinHandle<T>>

where F: FnOnce() -> T + Send + 'static, T: Send + 'static,

Spawns a new thread by taking ownership of the Builder, and returns an std::io::Result to its JoinHandle.

pub unsafe fn spawn_unchecked<'a, F, T>(self, f: F) -> Result<JoinHandle<T>>

where F: FnOnce() -> T + Send + 'a, T: Send + 'a,

Spawns a new thread without any lifetime restrictions by taking ownership of the Builder, and returns an std::io::Result to its JoinHandle.

Safety

The caller has to ensure that no references in the supplied thread closure or its return type can outlive the spawned thread’s lifetime. This can be guaranteed in two ways:

• ensure that join is called before any referenced data is dropped
• use only types with 'static lifetime bounds, i.e., those with no or only 'static references (both Builder::spawn and spawn enforce this property statically)

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.