Struct Plan

pub struct Plan { /* private fields */ }

A reproducible operation plan.

Carries the options every step runs under and the provenance of the steps taken so far. Re-executing the same plan against the same inputs must produce the same result; the recorded steps are the evidence of what ran.

Implementations

impl Plan

pub fn new(options: ExecutionOptions) -> Self

Start a plan from the options every step will run under.

pub fn options(&self) -> &ExecutionOptions

Options every step of this plan runs under.

pub fn steps(&self) -> &[PlanStep]

Steps recorded so far, in execution order.

impl Plan

pub fn admit( &mut self, step: PlanStep, scratch: ScratchRequirement, elements: usize, ) -> GeomResult<()>

Admit and record a step, or refuse it.

Two admissions, both fail-closed:

• The provider’s guaranteed determinism must be at least the level the plan requested. A provider that cannot meet the request is refused rather than silently downgraded, because the caller has no other way to learn the guarantee it relied on was not delivered.
• The step’s scratch requirement must fit the plan’s memory budget. Exhaustion is a typed BudgetExceeded, never a silent truncation to a smaller result that still looks plausible.

Trait Implementations

impl Clone for Plan

fn clone(&self) -> Plan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Plan

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

Formats the value using the given formatter.

impl PartialEq for Plan

fn eq(&self, other: &Plan) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Plan