Skip to main content

Crate oxide_batch_plan

Crate oxide_batch_plan 

Source
Expand description

Internal implementation crate for OxideBatch.

This crate is implementation detail. Use oxide-batch instead.

It exists on crates.io only because the published oxide-batch facade depends on it. Its API carries no stability promise: items may be added, changed, or removed in any release, without a deprecation period. It has no supported-configuration matrix, no compatibility ledger row, and no independent release cadence.

Everything here that OxideBatch supports is re-exported from oxide-batch under a stable path.

The crate holds immutable flow graphs and the compiled execution plans they lower into. An application declares a FlowGraph of step and decision nodes joined by exit-pattern transitions, then compiles it into an immutable CompiledExecutionPlan. Compilation normalizes the graph, rejects every structural error the accepted basic-flow contract names, and produces the canonical manifest whose SHA-256 digest is the definition fingerprint.

The graph remains finite and acyclic. M4 adds bounded local split and partition forms. M7 adds bounded nested-flow composition and split-branch subgraphs while retaining one compiled-plan authority; nested jobs and remote execution remain separate lifecycle boundaries. Existing one-step TaskletJob and ChunkJob definitions lower into a compatibility plan that retains their original format-1 manifest bytes and fingerprint.

The crate depends on no async runtime, database driver, command-line framework, telemetry SDK, broker client, or web framework, and on no OxideBatch crate other than oxide-batch-core. The flow engine that executes a compiled plan, the metadata ports that persist its decisions, and the runtime live above this crate.

§Items marked #[doc(hidden)]

Some items exist as #[doc(hidden)] pub only because the facade’s own code was split from these types by the extraction boundary: private access that one crate resolved by module privacy now crosses a crate boundary. They are not part of any surface, supported or otherwise, and the facade never re-exports one under its own name. The staged crate-extraction contract records each one.

Structs§

CompiledExecutionPlan
A validated, immutable execution plan.
CompiledFlowScope
One validated execution scope inside an M7 composed plan.
CustomLeafKind
A stable application-owned kind identifier for one registered custom leaf.
CustomLeafNode
One bounded registered custom-leaf declaration in a format-4 flow.
DeciderRevision
An application-owned revision token for one deterministic decider.
DecisionInputVersion
The version of the durable input contract one decider reads.
DecisionNode
One deterministic decision node of a compiled plan.
ExitPattern
A bounded exit-outcome pattern used to select one transition.
FlowGraph
An immutable declaration of the M3 flow subset.
FlowTransition
One declared transition edge.
JoinNode
The structural join owned by one M4 split.
LateBoundInput
One named, deterministic late-bound input to a scoped component factory.
NestedFlow
One reusable M7 flow embedded under a stable structural owner.
NestedJobNode
A format-4 nested-job lifecycle boundary.
NestedJobParameterMapping
One deterministic typed child-parameter mapping.
PartitionBudget
The finite worker and connection budget for one M4 partition manager.
PartitionCount
A finite durable partition count for one M4 partitioned step.
PartitionedStepNode
A bounded local partition manager and its ordinary worker-step definition.
PatternSpecificity
The computed specificity of one exit pattern.
RepeatDefinition
Canonical restart-relevant repeat declaration for one step.
RepeatId
A stable logical identifier for one repeat definition.
RepeatInterceptorDefinition
Restart-relevant identity of one ordered repeat interceptor.
RepeatInterceptorId
A stable logical identifier for one repeat interceptor registration.
RepeatInterceptorKind
A stable application-owned kind identifier for one repeat interceptor.
RepeatPolicyConfiguration
A bounded restart-relevant configuration fingerprint for one repeat policy.
RepeatPolicyDefinition
Restart-relevant identity of one repeat policy.
RepeatPolicyKind
A stable application-owned kind identifier for one repeat policy.
RepeatStateSchema
Bounded durable state-schema identity for one repeat definition.
ScopeFactoryKind
A stable application-owned kind identifier for one scoped component factory.
ScopeResolverKind
A stable application-owned kind identifier for one scoped late-binding resolver.
ScopedComponentDefinition
Restart-relevant declaration for one job- or step-scoped component.
ScopedComponentId
Stable logical identity of one job- or step-scoped component.
SelectorPath
A bounded structured path into committed execution-context state.
SplitBranch
One split branch. M4 branches are linear; M7 may embed a bounded flow.
SplitBudget
The finite concurrency and connection budget for one M4 split.
SplitNode
A bounded M4 split whose branches converge at exactly one join node.
StepNode
One executable node of a compiled plan.

Enums§

FlowNode
One node of a declared flow graph.
FlowSelectionError
A compiled plan that cannot route one observed exit outcome.
FrameworkParameterSource
Closed framework metadata that a nested-job mapping may read.
LateBindingDefinitionError
Stable failures produced while validating a scoped-component definition.
LateBoundSource
One accepted source family for a scoped late-bound value.
LocalFailurePolicy
The sibling behavior selected after one local child fails.
MissingParameterPolicy
Closed behavior when a mapping source is absent.
NestedJobParameterSource
One accepted source family for a nested-job child parameter.
ParameterCoercion
Explicit deterministic coercion applied after source selection.
PlanError
A flow graph that cannot be compiled into an executable plan.
RepeatDefinitionError
Stable failures while constructing bounded repeat definition metadata.
ScopeFrameworkSource
Closed framework-owned metadata that a scoped resolver may read.
ScopeKind
Runtime lifetime of one scoped component definition.
StepComponents
The executable kind and restart-relevant declaration of one step node.

Constants§

MAX_BRANCH_STEPS
The maximum number of linear steps in one split branch.
MAX_FLOW_COMPOSITION_DEPTH
The maximum structural nesting depth of an M7 composed flow.
MAX_LATE_BOUND_INPUTS
Maximum number of late-bound values one scoped component may declare.
MAX_NESTED_JOB_PARAMETERS
Maximum number of typed child parameters one nested-job node may declare.
MAX_OUTGOING_TRANSITIONS
The maximum number of transitions leaving one node.
MAX_PARTITION_WORKERS
The maximum number of concurrent local partition workers.
MAX_PATTERN_BYTES
The maximum length of one exit pattern in UTF-8 bytes.
MAX_SCOPED_COMPONENTS
Maximum number of live scoped components one execution scope may own.
MAX_SELECTOR_PATH_BYTES
Maximum UTF-8 bytes across one structured selector path.
MAX_SELECTOR_PATH_SEGMENTS
Maximum number of path segments in one structured selector.
MAX_SPLIT_BRANCHES
The maximum number of branches in one M4 split.