Struct ThreadPool

Source
pub struct ThreadPool { /* private fields */ }
Expand description

§Thread pool for managing background tasks

The thread pool operates on “routines”, which are effectively closures called repeatedly by the thread pool until they return ControlFlow::Break.

To submit a task, pass it to ThreadPool::subscribe and store the received handle. To cancel a task, pass its handle to ThreadPool::unsubscribe.

Implementations§

Source§

impl ThreadPool

Source

pub fn subscribe<F>(&self, func: F) -> Result<Routine, Error>
where F: FnMut() -> ControlFlow<()> + Send + 'static,

Run a task in a background thread

Source

pub fn unsubscribe(&self, routine: &Routine) -> Result<(), Error>

Cancel a task running in a background thread

Note: this does not kill a running task, only prevent it from being scheduled again

Trait Implementations§

Source§

impl Debug for ThreadPool

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.