Skip to main content

Module execution

Module execution 

Source
Expand description

Bounded execution contracts for streaming and out-of-core work.

Producers are pulled one batch at a time. Each pull carries explicit row and byte demand, while retained memory is charged to a shared budget through an RAII reservation. This keeps live workspace proportional to concurrent batch demand rather than total input size. Cancellation and storage policy travel in the same cheap-to-clone context.

Structs§

BatchBufferPool
One-slot pool that keeps a reusable batch and its memory charge together.
BatchDemand
Maximum work a consumer is prepared to accept from one pull.
BatchLease
A batch whose retained bytes are charged to an execution context.
CancellationToken
A cheap, thread-safe cooperative cancellation handle.
Cancelled
An execution stopped after cooperative cancellation was requested.
ExecutionContext
Shared controls passed through every stage of an out-of-core operation.
ExecutionContextBuilder
Declarative construction of an ExecutionContext.
MemoryBudget
A validated upper bound for memory retained by one execution context.
MemoryReservation
Exclusive accounting for bytes retained by an operation.
Retained
An owned result retaining the reservation for its backing allocations.
ScratchPolicy
Upper bound for reusable in-memory scratch owned by one stage.
SpillArtifact
Immutable temporary records deleted when the artifact is dropped.
SpillFile
Append-only temporary file charged to one execution context.
SpillReader
Sequential reader that reuses caller-owned payload capacity.
TemporaryWorkspace
Private native-tool files retaining one shared temporary-storage reservation.

Enums§

Backpressure
Outcome of one non-blocking batch pull.
ContextError
Inconsistent execution policies supplied to a context builder.
MemoryBudgetError
Failure to construct or reserve an execution-memory budget.
SpillError
Failure to create, write, or validate bounded temporary storage.
TempStoragePolicy
Policy controlling whether and where execution may spill temporary data.

Constants§

DEFAULT_MEMORY_BUDGET_BYTES
Smallest automatic execution budget, and the legacy fixed default: 100 MB.
MAX_AUTOMATIC_BUDGET_BYTES
Largest automatic budget: 512 GiB. Explicit budgets are not capped.
MEMORY_BUDGET_ENV
Environment variable that overrides the automatic budget (4GiB, 512MB, bytes).
MEMORY_BUDGET_REMEDY
The text every memory refusal appends so the caller can act on it.

Traits§

Batch
A bounded unit of columnar or row-oriented work.
BatchSource
A pull source whose live workspace is governed by an ExecutionContext.