Skip to main content

oxide_batch_core/
lib.rs

1//! Internal implementation crate for `OxideBatch`.
2//!
3//! **This crate is implementation detail. Use
4//! [`oxide-batch`](https://crates.io/crates/oxide-batch) instead.**
5//!
6//! It exists on crates.io only because the published `oxide-batch` facade
7//! depends on it. Its API carries no stability promise: items may be added,
8//! changed, or removed in any release, without a deprecation period. It has no
9//! supported-configuration matrix, no compatibility ledger row, and no
10//! independent release cadence.
11//!
12//! Everything here that `OxideBatch` supports is re-exported from `oxide-batch`
13//! under a stable path.
14//!
15//! The crate holds domain identities, typed job parameters, statuses and exit
16//! statuses, execution records and their lifecycle rules, bounded versioned
17//! execution-context and checkpoint state, chunk sizing and counting values,
18//! and restart-relevant definition identity with its canonical manifest
19//! encoding. It depends on no async runtime, database driver, command-line
20//! framework, telemetry SDK, broker client, or web framework, and on no other
21//! `OxideBatch` crate.
22
23#![forbid(unsafe_code)]
24
25mod chunk;
26mod component_state;
27mod definition;
28mod domain;
29mod fault;
30mod flow;
31mod scope;
32mod state;
33
34pub use chunk::{ChunkCount, ChunkCounts, ChunkError, ChunkProgress, ChunkSize};
35pub use component_state::{
36    ChecksumAlgorithm, CodecId, CodecVersion, CodecVersionUpgrade, ComponentStateCodec,
37    ComponentStateEnvelope, ComponentStateError, ComponentStatePayload, ContentIdentity,
38    DefaultComponentCodec, ExternalStateError, ExternalStateReference, ExternalStateStore,
39    RestartabilityDeclaration, StateSensitivity, StreamStateContract,
40};
41pub use definition::{
42    ChunkComponentRevisions, ChunkDeliveryMode, ChunkRestartContract, ClassifierRevision,
43    ComponentRevision, ComponentStreamIdentity, DefinitionArtifactId, DefinitionError,
44    DefinitionIdentity, DefinitionManifest, DefinitionNodeUpgrade, DefinitionRevision,
45    DefinitionStateKind, DefinitionStateTransform, DefinitionStateTransformError,
46    DefinitionStateTransformId, DefinitionStateTransformer, DefinitionTokenKind, DefinitionUpgrade,
47    DefinitionUpgradeExecution, DefinitionUpgradeKey, DefinitionUpgradeRevision, InFlightPolicy,
48    ManifestError, ParameterIncrementerIdentity, RepeatId, StepDefinitionUpgrade,
49};
50pub use definition::{
51    MANIFEST_FORMAT_ADVANCED_FLOW, MANIFEST_FORMAT_FLOW, MANIFEST_FORMAT_LOCAL_SCALE,
52    MANIFEST_FORMAT_ONE_STEP, MAX_DEFINITION_UPGRADE_NODES, MAX_DEFINITION_UPGRADE_TRANSFORMS,
53    MAX_NODES, MAX_REPEAT_INTERCEPTORS, MAX_REPEAT_NESTING_DEPTH, MAX_TRANSITIONS,
54    check_manifest_format, validate_token,
55};
56pub use domain::{
57    BatchStatus, DomainError, ExecutionCounts, ExecutionMetadata, ExecutionTimestamps,
58    ExecutionVersion, ExitCode, ExitStatus, FailureCategory, FailureId, FailureSummary,
59    IdentifierKind, JobExecution, JobExecutionId, JobInstance, JobInstanceId, JobInstanceKey,
60    JobName, JobParameter, JobParameters, LifecycleError, LifecycleTransition, NameKind,
61    OperatorRequestId, ParameterName, ParameterRole, ParameterValue, ParameterValueKind,
62    RecoveryDecisionId, RetentionActionId, StepExecution, StepExecutionId, StepName,
63    StepPartitionId,
64};
65pub use fault::{
66    BackoffKind, BackoffPolicy, FaultAction, FaultClassifier, FaultDecision, FaultDescriptor,
67    FaultEvidence, FaultPhase, FaultPolicy, FaultPolicyError, FaultRule, RetryLimit, RetryOrdinal,
68    RetryStateLimit, RollbackDisposition, SkipCounts, SkipLimit,
69};
70pub use flow::{
71    FlowTarget, MAX_PARTITIONS, NodeId, RestartPolicy, StartControls, StartLimit, TerminalKind,
72};
73pub use scope::{
74    MAX_LATE_BOUND_INPUTS, MAX_SCOPED_COMPONENTS, MAX_SELECTOR_PATH_BYTES,
75    MAX_SELECTOR_PATH_SEGMENTS, ScopeFrameworkSource, ScopeKind, ScopedComponentId,
76    selector_path_is_valid,
77};
78pub use state::{
79    Checkpoint, DurableStateKind, ExecutionContext, StateCodecError, StateError, StateLimits,
80    StateSchemaId, StateSchemaUpgrade, StateSchemaVersion, VersionedStateCodec,
81};