Struct BackgroundJobs 

pub struct BackgroundJobs { /* private fields */ }

One session’s background jobs. Dropping the store (with the session’s tools) cancels every job still running.

Implementations

impl BackgroundJobs

pub fn new(limit: usize, finished: Option<UnboundedSender<()>>) -> Self

At most limit jobs run at once. finished is woken as jobs finish.

pub fn with_approvals(self, gate: Arc<dyn ApprovalGate>) -> Self

Decide running jobs’ nested approval requests with gate, which must never grant more than the session’s foreground would.

pub fn take_changes(&self, call_id: &str) -> Vec<JobChange>

The jobs the call call_id started or showed the model the result of, for its tool.completed.

pub fn take_unreported(&self) -> Vec<JobReport>

Finished jobs the model has not seen yet whose report is due, at most a few, for a report turn. Each stays unreported, and is not taken again, until the turn ends: report_settled or report_failed.

pub fn report_settled(&self, jobs: &[String])

The report turn about jobs ended without failing: it completed, so the model has seen them, or the user cancelled it. Either settles them.

pub fn report_failed(&self, jobs: &[String], retry: bool) -> ReportFailure

The report turn about jobs failed, so the model has not seen them (a failed turn leaves no history). With retry, another turn is due after a delay, up to three turns in all; otherwise, or once they are used up, the jobs are settled and returned for the server to report directly. A turn that reported several jobs decides for all of them, by the one that failed most.

pub fn retry_now(&self) -> bool

Make every report waiting out a failed turn due now, as once a turn succeeds and the model is evidently reachable again. Whether any was waiting.

pub fn next_retry(&self) -> Option<Instant>

When the earliest report waiting out a failed turn is due; it may already have passed.

pub fn pending(&self) -> usize

Jobs still running or whose result is not reported yet, including those a report turn is reporting now.

pub fn running(&self) -> usize

Whether any job is still running.

Trait Implementations

impl Debug for BackgroundJobs

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

Formats the value using the given formatter.

impl Drop for BackgroundJobs

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.