TaskPool

Struct TaskPool 

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

A concurrent task execution pool with semaphore-based concurrency control.

TaskPool manages the execution of asynchronous tasks with a configurable limit on the number of concurrent tasks. It provides cancellation support and automatic resource cleanup.

§Thread Safety

TaskPool is thread-safe and can be cloned to share across multiple contexts. All clones share the same underlying semaphore and cancellation token.

Implementations§

Source§

impl TaskPool

Source

pub fn new(n_tasks: usize) -> TaskPool

Creates a new TaskPool with the specified concurrency limit.

§Arguments
  • n_tasks - Maximum number of tasks that can execute concurrently
§Examples
use quetty_server::taskpool::TaskPool;

let pool = TaskPool::new(5); // Allow up to 5 concurrent tasks
Source

pub fn execute<F, T>(&self, func: F)
where F: Future<Output = T> + Send + 'static, T: Send,

Executes a future in the task pool with concurrency control.

The task will wait for a semaphore permit before executing. If the pool is cancelled while the task is running, it will be interrupted gracefully.

§Type Parameters
  • F - Future type that implements Send and has a static lifetime
  • T - Output type of the future that implements Send
§Arguments
  • func - The async function/future to execute
§Examples
use quetty_server::taskpool::TaskPool;

async fn example() {
    let pool = TaskPool::new(3);

    pool.execute(async {
        println!("Task is running");
        // Do some work
    });
}
Source

pub fn cancel_all(&self)

Cancels all currently running and queued tasks.

This sends a cancellation signal to all tasks. Tasks that are currently executing will be interrupted at their next cancellation check point. Tasks waiting for permits will be cancelled before they start.

§Examples
use quetty_server::taskpool::TaskPool;

async fn example() {
    let pool = TaskPool::new(3);

    // Start some tasks
    for i in 0..10 {
        pool.execute(async move {
            println!("Task {}", i);
        });
    }

    // Cancel all tasks
    pool.cancel_all();
}
Source

pub fn close(&self)

Closes the task pool to prevent new tasks from starting.

This closes the underlying semaphore, which prevents new tasks from acquiring permits. Tasks that are already running will continue to completion.

§Examples
use quetty_server::taskpool::TaskPool;

async fn example() {
    let pool = TaskPool::new(3);

    // Use the pool...

    // Close it to prevent new tasks
    pool.close();
}

Trait Implementations§

Source§

impl Clone for TaskPool

Source§

fn clone(&self) -> TaskPool

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Drop for TaskPool

Source§

fn drop(&mut self)

Automatically closes the semaphore when the last TaskPool reference is dropped.

This ensures that resources are properly cleaned up when the task pool is no longer needed. The semaphore is only closed when this is the last remaining reference to prevent premature shutdown.

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> SendBound for T
where T: Send,