Struct base::WorkerThread

pub struct WorkerThread<T: Send + 'static> {
    worker: Option<(Event, JoinHandle<T>)>,
}

Wrapper object for creating a worker thread that can be stopped by signaling an event.

Fields

worker: Option<(Event, JoinHandle<T>)>

Implementations

impl<T: Send + 'static> WorkerThread<T>

pub fn start<F>(thread_name: impl Into<String>, thread_func: F) -> Self

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

Starts a worker thread named thread_name running the thread_func function.

The thread_func implementation must monitor the provided Event and return from the thread when it is signaled.

Call stop() to stop the thread.

pub fn stop(self) -> T

Stops the worker thread.

Returns the value returned by the function running in the thread.

pub fn signal(&mut self) -> Result<(), Error>

Signal thread’s stop event. Unlike stop, the function doesn’t wait on joining the thread. The function can be called multiple times. Calling stop or drop will internally signal the stop event again and join the thread.

pub fn thread(&self) -> &Thread

Returns a handle to the running thread.

Trait Implementations

impl<T: Send + 'static> Drop for WorkerThread<T>

fn drop(&mut self)

Stops the thread if the WorkerThread is dropped without calling stop().