Struct Pool 

pub struct Pool { /* private fields */ }

Task pool

Implementations

impl Pool

pub fn bounded(capacity: usize) -> Self

Creates a bounded pool (recommended)

pub fn unbounded() -> Self

Creates an unbounded pool

pub fn with_id<I: Into<String>>(self, id: I) -> Self

pub fn id(&self) -> Option<&str>

pub fn with_spawn_timeout(self, timeout: Duration) -> Self

Sets spawn timeout

(ignored for unbounded)

pub fn with_run_timeout(self, timeout: Duration) -> Self

Sets the default task run timeout

pub fn with_timeout(self, timeout: Duration) -> Self

Sets both spawn and run timeouts

pub fn with_no_logging_enabled(self) -> Self

Disables internal error logging

pub fn capacity(&self) -> Option<usize>

Returns pool capacity

pub fn available_permits(&self) -> Option<usize>

Returns pool available task permits

pub fn busy_permits(&self) -> Option<usize>

Returns pool busy task permits

pub fn spawn<T>(&self, future: T) -> impl Future<Output = SpawnResult<T>> + '_

where T: Future + Send + 'static, T::Output: Send + 'static,

Spawns a future

pub fn spawn_with_timeout<T>( &self, future: T, timeout: Duration, ) -> impl Future<Output = SpawnResult<T>> + '_

where T: Future + Send + 'static, T::Output: Send + 'static,

Spawns a future with a custom timeout

pub async fn spawn_task<T>(&self, task: Task<T>) -> SpawnResult<T>

where T: Future + Send + 'static, T::Output: Send + 'static,

Spawns a task (a future which can have a custom ID and timeout)

pub fn try_spawn<T>(&self, future: T) -> SpawnResult<T>

where T: Future + Send + 'static, T::Output: Send + 'static,

Tries to spawn a future if there is an available permit. Returns Error::NotAvailable if no permit available

pub fn try_spawn_with_timeout<T>( &self, future: T, timeout: Duration, ) -> SpawnResult<T>

where T: Future + Send + 'static, T::Output: Send + 'static,

Tries to spawn a future with a custom timeout if there is an available permit. Returns Error::NotAvailable if no permit available

pub fn try_spawn_task<T>(&self, task: Task<T>) -> SpawnResult<T>

where T: Future + Send + 'static, T::Output: Send + 'static,

Spawns a task (a future which can have a custom ID and timeout) if there is an available permit. Returns Error::NotAvailable if no permit available

Trait Implementations

impl Debug for Pool

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

Formats the value using the given formatter.

impl Default for Pool

fn default() -> Self

Returns the “default value” for a type.