Struct Context 

pub struct Context { /* private fields */ }

Cancellation, progress, threads and memory available to one heavy job.

Implementations

impl Context

pub fn new( threads: usize, budget: MemoryBudget, progress: Arc<dyn ProgressSink>, cancel: CancelToken, ) -> Self

Creates a context. A zero thread request is treated as one thread.

pub fn child_serial(&self) -> Context

A one-thread context for work that runs inside one of this job’s items: it reserves from the same budget and stops with the same token, and reports no progress of its own.

pub fn serial() -> Self

Creates a one-thread context with an unlimited budget and no reporting.

pub fn cancel(&self) -> &CancelToken

Returns this job’s cancellation token.

pub fn budget(&self) -> &MemoryBudget

Returns this job’s memory budget.

pub fn stage(&self, stage: &'static str, total: u64) -> StageProgress<'_>

Starts a progress stage and immediately reports its initial state.

pub fn map<T: Send, U: Send>( &self, items: Vec<T>, f: impl Fn(T) -> U + Sync + Send, ) -> Result<Vec<U>, Cancelled>

Applies f through this context while preserving input order.

pub fn try_map<T: Send, U: Send, E: Send>( &self, items: Vec<T>, f: impl Fn(T) -> Result<U, E> + Sync + Send, ) -> Result<Vec<U>, MapError<E>>

Applies fallible f while preserving order and reports the lowest failing item index.

Trait Implementations

impl Debug for Context

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

Formats the value using the given formatter.