Struct TaskPool

pub struct TaskPool<V, P>
where
    P: Progressible,
{ /* private fields */ }

A pool to manage long-running tasks.

Implementations

impl<V, P> TaskPool<V, P>

where P: Progressible + Clone,

pub fn with_lifespan(self, lifespan: Option<Duration>) -> Self

Configure the lifespan of tasks. None means that tasks will never expire. Expired tasks are purged as soon as complete is invoked. Specifying a lifespan is useful because clients might not always retrieve completed tasks. Without configuring a lifespan, such abandoned tasks accumulate over time and fill up memory.

pub fn insert(&mut self, pending: P) -> (Handle, Uuid)

Insert a task’s initial progress to receive a Handle and Uuid referencing the task.

pub fn retrieve(&mut self, uuid: &Uuid) -> Option<TaskState<V, P>>

Get the task state and remove it from the pool if it is done.

pub fn progress(&mut self, handle: &Handle)

Report progress on a pending task. Calls Progressible::progress on the corresponding progress state.

pub fn complete(&mut self, handle: Handle, value: V)

Mark the task associated to the handle as completed with a value of type T. The handle must be passed by value so that this is the final action. As a side effect expired tasks are purged.

Trait Implementations

impl<V, P> Default for TaskPool<V, P>

where P: Progressible,

fn default() -> Self

Returns the “default value” for a type.