Struct wasm_thread::Builder

pub struct Builder { /* fields omitted */ }

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

Implementations

impl Builder

pub fn new() -> Builder

Generates the base configuration for spawning a thread, from which configuration methods can be chained.

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

Names the thread-to-be.

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

Sets the size of the stack (in bytes) for the new 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,
    F: Send + 'static,
    T: Send + 'static, 

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

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

Spawns a new thread without any lifetime restrictions by taking ownership of the Builder, and returns an [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 Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the "default value" for a type.