Crate oxide_batch_core

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 domain identities, typed job parameters, statuses and exit statuses, execution records and their lifecycle rules, bounded versioned execution-context and checkpoint state, chunk sizing and counting values, and restart-relevant definition identity with its canonical manifest encoding. It depends on no async runtime, database driver, command-line framework, telemetry SDK, broker client, or web framework, and on no other OxideBatch crate.

Macros§

definition_token: Declares one validated, application-owned definition token type.

Structs§

BackoffPolicy: A deterministic, jitter-free backoff schedule.
Checkpoint: A bounded, versioned reader position committed with a chunk.
ChunkComponentRevisions: Component revisions for a one-step chunk definition.
ChunkCount: A checked non-negative item or transaction count.
ChunkCounts: Validated item counts within one open chunk.
ChunkProgress: Mutable, invariant-preserving progress for one bounded chunk.
ChunkRestartContract: Restart-state schemas and delivery mode for a chunk definition.
ChunkSize: A nonzero item limit for one chunk.
ClassifierRevision: An application-owned revision token for one bounded fault classifier.
ComponentRevision: An application-owned revision token for one opaque executable component.
DefinitionIdentity: Canonical restart-relevant identity persisted with every execution.
DefinitionManifest: A validated, read-only view of one canonical definition manifest.
DefinitionRevision: An application-owned audit label for one restart-relevant definition.
DefinitionUpgrade: One explicit, directed definition compatibility edge.
DefinitionUpgradeKey: An application-owned key for one directed definition compatibility edge.
ExecutionContext: Bounded, versioned application restart state committed with a chunk.
ExecutionCounts: Durable item and transaction counters for an execution.
ExecutionMetadata: Validated lifecycle, outcome, timestamps, counters, and failure metadata.
ExecutionTimestamps: Validated creation, start, and end instants for an execution attempt.
ExecutionVersion: A database-agnostic optimistic-lock version for an execution record.
ExitCode: A validated flow- and operator-facing exit code.
ExitStatus: A flow- and operator-facing result kept separate from BatchStatus.
FailureId: An opaque identifier used to correlate a redacted failure.
FailureSummary: A value-redacted failure summary suitable for execution inspection.
FaultAction: The action a classifier rule declares for one phase and category.
FaultClassifier: A bounded, order-independent classifier over phases and categories.
FaultDescriptor: The complete framework-owned classification input for one fault.
FaultEvidence: Framework evidence about one failed unit of work.
FaultPolicy: The validated retry, backoff, skip, and rollback policy for one step.
FaultRule: One ordered classifier rule for an exact phase and category.
JobExecution: One launch or restart attempt for a JobInstance.
JobExecutionId: An opaque identifier for one job launch or restart attempt.
JobInstance: One logical occurrence of a named job and its identifying parameters.
JobInstanceId: An opaque identifier for one logical job instance.
JobInstanceKey: The canonical identity key for a logical job instance.
JobName: A validated logical job-definition name.
JobParameter: One typed job parameter and its identity role.
JobParameters: A deterministically ordered set of typed job parameters.
LifecycleTransition: A requested framework lifecycle transition and its deterministic timestamp.
NodeId: A stable logical identifier for one flow-graph node.
OperatorRequestId: An opaque identifier for one append-only operator request record.
ParameterName: A validated job-parameter name.
ParameterValue: A bounded typed job-parameter value.
RecoveryDecisionId: An opaque identifier for one append-only recovery decision.
RetentionActionId: An opaque identifier for one append-only retention audit record.
RetryLimit: The maximum number of re-invocations after the initial component call.
RetryOrdinal: The zero-based invocation ordinal for one retry key.
RetryStateLimit: The maximum number of unresolved retry keys retained for one step.
SkipCounts: Durable committed skip counts, kept distinct per phase.
SkipLimit: The maximum aggregate committed skips for one step in one job instance.
StartControls: Restart-relevant start controls for one logical step.
StartLimit: The maximum number of step executions one logical step may start.
StateLimits: Resource bounds checked before application payload decoding.
StateSchemaId: A validated application-owned durable-state schema identifier.
StateSchemaUpgrade: One directed application-schema upgrade a codec declares.
StateSchemaVersion: A nonzero application schema version.
StepDefinitionUpgrade: One source-to-target durable step mapping for a compatible restart.
StepExecution: One attempt to execute a named step within a job execution.
StepExecutionId: An opaque identifier for one step attempt.
StepName: A validated logical step-definition name.
StepPartitionId: An opaque identifier for one durable step partition.

Enums§

BackoffKind: The deterministic backoff family selected by a definition.
BatchStatus: The framework lifecycle status of a job or step execution.
ChunkDeliveryMode: Declared delivery boundary included in a chunk definition fingerprint.
ChunkError: Stable chunk-size and count failure.
DefinitionError: Failure to construct a bounded restart definition.
DefinitionTokenKind: Definition token category used by validation diagnostics.
DomainError: A stable, value-redacted domain validation failure.
DurableStateKind: The durable state category being encoded or decoded.
FailureCategory: A stable framework category for a redacted failure.
FaultDecision: The authoritative policy outcome for one fault.
FaultPhase: The framework phase that produced a fault.
FaultPolicyError: A value-redacted fault-policy validation or arithmetic failure.
FlowTarget: The destination one transition selects.
IdentifierKind: The kind of opaque numeric identifier.
InFlightPolicy: The accepted shutdown behavior for an already-open chunk.
LifecycleError: A typed lifecycle-policy or optimistic-concurrency failure.
ManifestError: A canonical definition manifest that cannot be interpreted.
NameKind: The kind of validated domain name.
ParameterRole: Whether a job parameter participates in job-instance identity.
ParameterValueKind: The stable type discriminator for a ParameterValue.
RollbackDisposition: How a failed unit of work is separated from committed work.
StateCodecError: Stable, payload-redacted failures returned by an application codec.
StateError: Stable, value-redacted durable-state validation failure.
TerminalKind: A node that ends the job without starting further work.

Constants§

MANIFEST_FORMAT_FLOW: The canonical manifest format that captures a compiled flow graph.
MANIFEST_FORMAT_LOCAL_SCALE: The canonical manifest format for bounded M4 local-scale plans.
MANIFEST_FORMAT_ONE_STEP: The canonical manifest format for a one-step tasklet or chunk definition.
MAX_NODES: The maximum number of nodes one plan may contain.
MAX_PARTITIONS: The maximum number of durable local partitions in one partitioned step.
MAX_TRANSITIONS: The maximum number of transitions one plan may contain.

Traits§

VersionedStateCodec: Serializer-neutral application codec for one durable-state schema.

Functions§

check_manifest_format: Returns whether this runtime can interpret format.
validate_token: Validates one application-owned definition token.