Struct TerminableThreads

pub struct TerminableThreads<T, const N: usize> { /* private fields */ }

A basic thread manager that can signal all threads to terminate / finish early

Note that threads will only terminate if the Arc<AtomicBool> flag is used

Implementations

impl<T, const N: usize> TerminableThreads<T, N>

pub fn build() -> (TerminableThreadsBuilder<T, N>, Arc<AtomicBool>)

pub fn terminate(&self)

Signal all threads to terminate and cease operation

Note

This does not guarantee all threads will terminate, or can be terminated.

Threads will only terminate if the underlying function checks the flag passed to it.s

pub fn join( self, signal_terminate: bool, ) -> [Result<T, Box<dyn Any + Send + 'static>>; N]

Join all threads, optionally signalling termination

Optional termination signalling is useful because no termination signal will let allow a function to run until it has finished naturally, while early termination could stop operations earlier than wanted

Returns

[Result<T, Error>; N]

An array of length N containing the results of joining each thread

Trait Implementations

impl<T: Debug, const N: usize> Debug for TerminableThreads<T, N>

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

Formats the value using the given formatter.