Struct AsyncPool

pub struct AsyncPool<F> { /* private fields */ }

AsyncPool is a thread-based executor that runs asynchronous tasks on dedicated worker threads.

The pool collects tasks through a bounded channel and distributes them among threads, each of which runs its own Tokio executor. This design enables controlled concurrency and efficient use of system resources.

Implementations

impl<F> AsyncPool<F>

pub fn name(&self) -> &'static str

Returns the name of the AsyncPool.

pub fn metrics(&self) -> AsyncPoolMetrics<'_>

Returns the AsyncPoolMetrics that are updated by the pool.

impl<F> AsyncPool<F>

where F: Future<Output = ()> + Send + 'static,

pub fn new<S>(builder: AsyncPoolBuilder<S>) -> Result<Self>

where S: ThreadSpawn,

Creates a new AsyncPool based on the configuration specified by AsyncPoolBuilder.

This method initializes the dedicated worker threads and configures each executor with the defined concurrency limits.

pub fn spawn(&self, future: F)

Schedules a future for execution within the AsyncPool.

The task is added to the pool’s internal queue to be executed by an available worker thread.

Panics

This method panics if all receivers have been dropped which can happen when all threads of the pool panicked.

pub async fn spawn_async(&self, future: F)

Asynchronously enqueues a future for execution within the AsyncPool.

This method awaits until the task is successfully added to the internal queue.

Panics

This method panics if all receivers have been dropped which can happen when all threads of the pool panicked.

Trait Implementations

impl<F> Clone for AsyncPool<F>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for AsyncPool<F>

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

Formats the value using the given formatter.