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§
- Compiled
Execution Plan - A validated, immutable execution plan.
- Compiled
Flow Scope - One validated execution scope inside an M7 composed plan.
- Custom
Leaf Kind - A stable application-owned kind identifier for one registered custom leaf.
- Custom
Leaf Node - One bounded registered custom-leaf declaration in a format-4 flow.
- Decider
Revision - An application-owned revision token for one deterministic decider.
- Decision
Input Version - The version of the durable input contract one decider reads.
- Decision
Node - One deterministic decision node of a compiled plan.
- Exit
Pattern - A bounded exit-outcome pattern used to select one transition.
- Flow
Graph - An immutable declaration of the M3 flow subset.
- Flow
Transition - One declared transition edge.
- Join
Node - The structural join owned by one M4 split.
- Late
Bound Input - One named, deterministic late-bound input to a scoped component factory.
- Nested
Flow - One reusable M7 flow embedded under a stable structural owner.
- Nested
JobNode - A format-4 nested-job lifecycle boundary.
- Nested
JobParameter Mapping - One deterministic typed child-parameter mapping.
- Partition
Budget - The finite worker and connection budget for one M4 partition manager.
- Partition
Count - A finite durable partition count for one M4 partitioned step.
- Partitioned
Step Node - A bounded local partition manager and its ordinary worker-step definition.
- Pattern
Specificity - The computed specificity of one exit pattern.
- Repeat
Definition - Canonical restart-relevant repeat declaration for one step.
- Repeat
Id - A stable logical identifier for one repeat definition.
- Repeat
Interceptor Definition - Restart-relevant identity of one ordered repeat interceptor.
- Repeat
Interceptor Id - A stable logical identifier for one repeat interceptor registration.
- Repeat
Interceptor Kind - A stable application-owned kind identifier for one repeat interceptor.
- Repeat
Policy Configuration - A bounded restart-relevant configuration fingerprint for one repeat policy.
- Repeat
Policy Definition - Restart-relevant identity of one repeat policy.
- Repeat
Policy Kind - A stable application-owned kind identifier for one repeat policy.
- Repeat
State Schema - Bounded durable state-schema identity for one repeat definition.
- Scope
Factory Kind - A stable application-owned kind identifier for one scoped component factory.
- Scope
Resolver Kind - A stable application-owned kind identifier for one scoped late-binding resolver.
- Scoped
Component Definition - Restart-relevant declaration for one job- or step-scoped component.
- Scoped
Component Id - Stable logical identity of one job- or step-scoped component.
- Selector
Path - A bounded structured path into committed execution-context state.
- Split
Branch - One split branch. M4 branches are linear; M7 may embed a bounded flow.
- Split
Budget - The finite concurrency and connection budget for one M4 split.
- Split
Node - A bounded M4 split whose branches converge at exactly one join node.
- Step
Node - One executable node of a compiled plan.
Enums§
- Flow
Node - One node of a declared flow graph.
- Flow
Selection Error - A compiled plan that cannot route one observed exit outcome.
- Framework
Parameter Source - Closed framework metadata that a nested-job mapping may read.
- Late
Binding Definition Error - Stable failures produced while validating a scoped-component definition.
- Late
Bound Source - One accepted source family for a scoped late-bound value.
- Local
Failure Policy - The sibling behavior selected after one local child fails.
- Missing
Parameter Policy - Closed behavior when a mapping source is absent.
- Nested
JobParameter Source - One accepted source family for a nested-job child parameter.
- Parameter
Coercion - Explicit deterministic coercion applied after source selection.
- Plan
Error - A flow graph that cannot be compiled into an executable plan.
- Repeat
Definition Error - Stable failures while constructing bounded repeat definition metadata.
- Scope
Framework Source - Closed framework-owned metadata that a scoped resolver may read.
- Scope
Kind - Runtime lifetime of one scoped component definition.
- Step
Components - 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.