Struct ExecutionContext 

pub struct ExecutionContext { /* private fields */ }

Shared controls passed through every stage of an out-of-core operation.

Implementations

impl ExecutionContext

pub fn builder() -> ExecutionContextBuilder

Starts a declarative context builder with bounded defaults.

pub fn with_cancellation(&self, cancellation: CancellationToken) -> Self

Shares resource accounts and the executor while assigning task-local cancellation. Cancelling this task does not cancel independent tasks using the same budgets.

pub const fn image_search_limit(&self) -> usize

The most candidate symmetry images a crystal search may examine.

A crystal environment is found by trying every symmetry operation and lattice translation that could bring a copy within reach, so the work grows with the unit’s extent as well as its atom count. Exceeding the limit is an error, never a silent truncation; raise it deliberately after reviewing the cost.

pub fn memory_budget(&self) -> MemoryBudget

Returns this context’s execution-memory ceiling.

pub const fn worker_budget(&self) -> usize

Maximum native tasks one operation may submit to the shared pool.

pub const fn cancellation(&self) -> &CancellationToken

Returns the shared cooperative cancellation token.

pub const fn scratch_policy(&self) -> ScratchPolicy

Returns the reusable scratch policy.

pub const fn temp_storage_policy(&self) -> &TempStoragePolicy

Returns the temporary-storage policy.

pub fn create_spill_file(&self, key: &str) -> Result<SpillFile, SpillError>

Creates one bounded, execution-owned spill file.

The key becomes the deterministic file name below the configured root. A file with the same key is never overwritten.

Errors

Returns SpillError::Disabled when spill is not configured, or a storage error when the key, disk budget, or destination is invalid.

pub fn spill_bytes(&self) -> u64

Returns temporary bytes currently retained by this execution graph.

pub fn total_spilled_bytes(&self) -> u64

Total physical bytes written to execution-owned spill files.

pub fn reserved_bytes(&self) -> usize

Bytes currently retained by execution-owned allocations.

pub fn peak_reserved_bytes(&self) -> usize

Highest number of execution-owned bytes retained concurrently.

pub fn live_batches(&self) -> usize

Batch leases that are currently alive.

pub fn peak_live_batches(&self) -> usize

Highest number of batch leases alive concurrently.

pub fn available_bytes(&self) -> usize

Bytes not yet reserved: the budget minus everything currently charged.

Tiled algorithms read this to shrink their block size to fit before they would otherwise refuse.

pub fn try_reserve( &self, bytes: usize, ) -> Result<MemoryReservation, MemoryBudgetError>

Charges retained bytes against this context until the result is dropped.

Errors

Returns MemoryBudgetError::Exhausted when the requested bytes do not fit alongside current reservations.

impl ExecutionContext

pub fn temporary_workspace( &self, maximum_bytes: u64, ) -> Result<TemporaryWorkspace, SpillError>

Reserves temporary bytes before creating one private native-tool directory. Concurrent tools and spill files share this context’s disk ceiling.

Errors

Returns disabled storage, exhausted reservation or filesystem errors.

pub fn temporary_workspace_with_file_limit( &self, maximum_bytes: u64, maximum_files: usize, ) -> Result<TemporaryWorkspace, SpillError>

Reserves a private directory with an explicit regular-file count ceiling.

Errors

Refuses zero file capacity, disabled storage or an exhausted disk budget.

Trait Implementations

impl Clone for ExecutionContext

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExecutionContext

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

Formats the value using the given formatter.

impl Default for ExecutionContext

fn default() -> Self

Returns the “default value” for a type.