Struct bounded_executor::BoundedExecutor

pub struct BoundedExecutor { /* fields omitted */ }

Implementations

impl BoundedExecutor

pub fn new(capacity: usize, executor: Handle) -> Self

Create a new BoundedExecutor from an existing tokio [Handle] with a maximum concurrent task capacity of capacity.

pub async fn spawn<F>(&self, future: F) -> JoinHandle<F::Output> where
    F: Future + Send + 'static,
    F::Output: Send + 'static, 

Spawn a Future on the BoundedExecutor. This function is async and will block if the executor is at capacity until one of the other spawned futures completes. This function returns a [JoinHandle] that the caller can .await on for the results of the Future.

pub fn try_spawn<F>(&self, future: F) -> Result<JoinHandle<F::Output>, F> where
    F: Future + Send + 'static,
    F::Output: Send + 'static, 

Try to spawn a Future on the BoundedExecutor. If the BoundedExecutor is at capacity, this will return an Err(F), passing back the future the caller attempted to spawn. Otherwise, this will spawn the future on the executor and send back a [JoinHandle] that the caller can .await on for the results of the Future.

pub async fn spawn_blocking<F, R>(&self, func: F) -> JoinHandle<R> where
    F: FnOnce() -> R + Send + 'static,
    R: Send + 'static, 

Like BoundedExecutor::spawn but spawns the given closure onto a blocking task (see [tokio::task::spawn_blocking] for details).

pub async fn try_spawn_blocking<F, R>(
    &self,
    func: F
) -> Result<JoinHandle<R>, F> where
    F: FnOnce() -> R + Send + 'static,
    R: Send + 'static, 

Like BoundedExecutor::try_spawn but spawns the given closure onto a blocking task (see [tokio::task::spawn_blocking] for details).

Trait Implementations

impl Clone for BoundedExecutor

fn clone(&self) -> BoundedExecutor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoundedExecutor

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

Formats the value using the given formatter.