BackgroundTaskManager

Struct BackgroundTaskManager 

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

Thread-scoped background task manager.

Manages the full lifecycle: spawn → track → cancel → query. Tasks outlive individual runs but are scoped to a thread.

Implementations§

Source§

impl BackgroundTaskManager

Source

pub fn new() -> Self

Source

pub fn with_task_store(task_store: Option<Arc<TaskStore>>) -> Self

Source

pub async fn spawn<F, Fut>( &self, owner_thread_id: &str, task_type: &str, description: &str, task: F, ) -> TaskId
where F: FnOnce(RunCancellationToken) -> Fut + Send + 'static, Fut: Future<Output = TaskResult> + Send,

Spawn a background task with the given closure.

Returns the generated TaskId immediately. The closure receives a CancellationToken for cooperative cancellation.

Source

pub async fn spawn_with_id<F, Fut>( &self, params: SpawnParams, cancel_token: RunCancellationToken, task: F, ) -> TaskId
where F: FnOnce(RunCancellationToken) -> Fut + Send + 'static, Fut: Future<Output = TaskResult> + Send,

Spawn a background task with a caller-supplied ID and cancellation token.

Use this when the caller already owns an ID (e.g. a sub-agent run_id) and/or a cancellation token that is shared with other subsystems.

Source

pub async fn cancel( &self, owner_thread_id: &str, task_id: &str, ) -> Result<(), String>

Cancel a task owned by the given thread. Returns true if cancelled.

Source

pub async fn get( &self, owner_thread_id: &str, task_id: &str, ) -> Option<TaskSummary>

Get a summary of a single task.

Source

pub async fn list( &self, owner_thread_id: &str, status_filter: Option<TaskStatus>, ) -> Vec<TaskSummary>

List all tasks for a thread, optionally filtered by status.

Source

pub async fn has_running_tasks(&self, owner_thread_id: &str) -> bool

Check if there are running tasks for a thread.

Source

pub async fn gc_terminal(&self, owner_thread_id: &str) -> usize

Remove completed/terminal task entries from the in-memory table.

Source

pub async fn contains(&self, owner_thread_id: &str, task_id: &str) -> bool

Check if a task exists for the given thread.

Source

pub async fn contains_any(&self, task_id: &str) -> bool

Check if a task exists in any thread.

Source

pub async fn cancel_tree( &self, owner_thread_id: &str, task_id: &str, ) -> Result<Vec<TaskSummary>, String>

Cancel a task and all its descendants (by parent_task_id chain).

Returns summaries of all tasks that were cancelled. The root task must be owned by owner_thread_id; descendants are found by traversing parent_task_id links within the same owner.

Source

pub async fn update_status( &self, task_id: &str, status: TaskStatus, error: Option<String>, ) -> bool

Externally update a task’s status (e.g. recovery marking orphans as stopped).

Source

pub async fn list_by_type( &self, owner_thread_id: &str, task_type: &str, status_filter: Option<TaskStatus>, ) -> Vec<TaskSummary>

List tasks filtered by task_type, optionally filtered by status.

Trait Implementations§

Source§

impl Clone for BackgroundTaskManager

Source§

fn clone(&self) -> BackgroundTaskManager

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 Debug for BackgroundTaskManager

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BackgroundTaskManager

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

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
§

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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