Struct stateful_async_worker::WorkerThread

pub struct WorkerThread<ThreadState, Result> { /* fields omitted */ }

Abstracts a stateful background worker thread, that can run synchronous functions and provide the return value as asynchronous future.

The thread owns an arbitrary ThreadState, which will be passed as a mutable reference to the called function. Thus the asynchronous code can easily access and mutate state when necessary. The worker will only process a single function at a time.

Implementations

impl<ThreadState, Result> WorkerThread<ThreadState, Result> where
    ThreadState: Default + Send + 'static,
    Result: Send + 'static, 

pub fn spawn() -> Self

Spawns a new worker thread. The state will be initialized with Default::default().

impl<ThreadState, Result> WorkerThread<ThreadState, Result> where
    ThreadState: Send + 'static,
    Result: Send + 'static, 

pub fn spawn_with(data: ThreadState) -> Self

Spawns a new worker thread. The state will be initialized with data.

pub async fn work_on<F>(&self, func: F) -> Result where
    F: FnOnce(&mut ThreadState) -> Result + Send + 'static, 

Pass a synchronous function, so the worker thread can execute it. Execution will be begin even before the first call to poll.

pub async fn work_on_boxed(
    &self,
    func: Box<dyn FnOnce(&mut ThreadState) -> Result + Send + 'static>
) -> Result

Like work_on but for functions that are already boxed.

Trait Implementations

impl<ThreadState, Result> Clone for WorkerThread<ThreadState, Result>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.