Struct Dispatcher

pub struct Dispatcher { /* private fields */ }

The dispatcher. It manages the threads and dispatches the tasks.

Implementations

impl Dispatcher

pub fn new() -> Result<Self>

Create the dispatcher with default config.

pub fn builder() -> DispatcherBuilder

Create a builder to build a dispatcher.

pub fn dispatch<Fn, Fut, R>( &self, f: Fn, ) -> Result<Receiver<R>, DispatchError<Fn>>

where Fn: FnOnce() -> Fut + Send + 'static, Fut: Future<Output = R> + 'static, R: Send + 'static,

Dispatch a task to the threads

The provided f should be Send because it will be send to another thread before calling. The returned Future need not to be Send because it will be executed on only one thread.

Error

If all threads have panicked, this method will return an error with the sent closure.

pub fn dispatch_blocking<Fn, R>( &self, f: Fn, ) -> Result<Receiver<R>, DispatchError<Fn>>

where Fn: FnOnce() -> R + Send + 'static, R: Send + 'static,

Dispatch a blocking task to the threads.

Blocking pool of the dispatcher will be obtained from the proactor builder. So any configuration of the proactor’s blocking pool will be applied to the dispatcher.

Error

If all threads are busy and the thread pool is full, this method will return an error with the original closure. The limit can be configured with DispatcherBuilder::proactor_builder and ProactorBuilder::thread_pool_limit.

pub async fn join(self) -> Result<()>

Stop the dispatcher and wait for the threads to complete. If there is a thread panicked, this method will resume the panic.

Trait Implementations

impl Debug for Dispatcher

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

Formats the value using the given formatter.