Struct ObjectStoreCheckpointStore 

pub struct ObjectStoreCheckpointStore { /* private fields */ }

Checkpoint store backed by any [ObjectStore] implementation.

Implementations

impl ObjectStoreCheckpointStore

pub fn new(store: Arc<dyn ObjectStore>, prefix: &str) -> Self

Create a store beneath a deployment-relative prefix.

Node namespaces are derived as {prefix}/nodes/{participant_id}/; callers must not include a node id in prefix.

pub fn with_exclusive_writer(self) -> Self

Permit exact overwrite transitions while an external lock excludes every other writer.

The caller must retain exclusive ownership of this checkpoint namespace for the complete store lifetime. Shared object-store deployments must use conditional updates instead.

pub fn with_participant_id(self, participant_id: u64) -> Self

Bind the store to one nonzero node id.

pub fn with_key_group_count(self, key_group_count: KeyGroupCount) -> Self

Set the exact vnode topology.

pub fn with_max_node_data_bytes( self, limit: u64, ) -> Result<Self, CheckpointStoreError>

Set the node-object byte limit.

Errors

Returns an error for zero or unrepresentable limits.

Trait Implementations

impl CheckpointStore for ObjectStoreCheckpointStore

fn max_node_data_bytes(&self) -> u64

Maximum bytes admitted for one node data object.

fn key_group_count(&self) -> KeyGroupCount

Stable vnode count expected in manifests.

fn participant_id(&self) -> u64

Node whose manifests this store writes.

fn save_checkpoint<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, manifest: &'life1 CheckpointManifest, node_data: &'life2 [Bytes], ) -> Pin<Box<dyn Future<Output = Result<Bytes, CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Validate and conditional-create the immutable node data object, then its manifest. Active inventory and exact Abort seals reconcile creates left ambiguous by caller cancellation.

fn save_sink_artifact_intents<'life0, 'life1, 'async_trait>( &'life0 self, chunk: StateChunkId, expected_artifact_identity_sha256: &'life1 str, intents: Vec<CheckpointSinkArtifactIntent>, ) -> Pin<Box<dyn Future<Output = Result<(), CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Persist every committable sink’s bounded cleanup intent before begin_epoch.

fn seal_aborted_manifest<'life0, 'life1, 'async_trait>( &'life0 self, chunk: StateChunkId, expected_artifact_identity_sha256: &'life1 str, sink_artifact_intent_protocol: bool, ) -> Pin<Box<dyn Future<Output = Result<CheckpointManifestAbortSeal, CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Replace this exact aborted manifest path with a monotone seal. The protocol flag must come from the exact active artifact inventory. If a valid manifest was already durable, preserve it inside the seal and return it with its canonical bytes.

fn complete_aborted_sink_cleanup<'life0, 'life1, 'async_trait>( &'life0 self, chunk: StateChunkId, expected_artifact_identity_sha256: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<CheckpointManifestAbortSeal, CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Mark exact prepared-sink cleanup complete on an already sealed manifest.

fn seal_aborted_node_data<'life0, 'life1, 'async_trait>( &'life0 self, chunk: StateChunkId, expected_artifact_identity_sha256: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Replace this exact aborted node-data path with a monotone seal after sink cleanup is durable.

fn load_manifest_for_participant<'life0, 'async_trait>( &'life0 self, participant_id: u64, checkpoint_id: u64, ) -> Pin<Box<dyn Future<Output = Result<Option<CheckpointManifest>, CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Load an exact manifest from a known participant namespace.

fn load_manifest_verified<'life0, 'life1, 'async_trait>( &'life0 self, participant_id: u64, checkpoint_id: u64, expected_len: u64, expected_sha256: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<CheckpointManifest>, CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Load a manifest only when its exact persisted length and digest match a committed index.

fn load_node_data_ranges<'life0, 'life1, 'async_trait>( &'life0 self, chunk: StateChunkId, expected_object_length: u64, ranges: &'life1 [ByteRange], ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<Bytes>>, CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read exact ranges after verifying the immutable object’s declared length.

fn delete_manifest<'life0, 'async_trait>( &'life0 self, chunk: StateChunkId, ) -> Pin<Box<dyn Future<Output = Result<(), CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Delete an explicitly identified manifest. GC must supply the identity from durable checkpoint metadata, never from object listing.

fn delete_node_data<'life0, 'async_trait>( &'life0 self, chunk: StateChunkId, ) -> Pin<Box<dyn Future<Output = Result<(), CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Delete an explicitly identified node object after its durable reference count reaches zero.

fn save_subscription_segment<'life0, 'life1, 'async_trait>( &'life0 self, segment: &'life1 OutputSegmentRef, payload: Bytes, ) -> Pin<Box<dyn Future<Output = Result<(), CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Create an immutable subscription segment, accepting an identical retry only.

fn load_subscription_segment<'life0, 'life1, 'async_trait>( &'life0 self, segment: &'life1 OutputSegmentRef, ) -> Pin<Box<dyn Future<Output = Result<Option<Bytes>, CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Load and verify an exact subscription segment without consulting object listing.

fn delete_subscription_segment<'life0, 'life1, 'async_trait>( &'life0 self, object_key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete an explicitly unreachable subscription segment.

fn delete_subscription_orphans<'life0, 'life1, 'async_trait>( &'life0 self, reachable: &'life1 BTreeSet<String>, through_checkpoint_id: u64, grace_before_ms: i64, ) -> Pin<Box<dyn Future<Output = Result<SubscriptionOrphanCleanup, CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete grace-expired segment objects not present in an authoritative reachable set. Object listing supplies candidates only; reachable and through_checkpoint_id are the caller’s committed-state authority.

fn load_manifest<'life0, 'async_trait>( &'life0 self, checkpoint_id: u64, ) -> Pin<Box<dyn Future<Output = Result<Option<CheckpointManifest>, CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Load this node’s exact manifest.

fn load_prepared_sink_descriptor<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, manifest: &'life1 CheckpointManifest, descriptor: &'life2 PreparedSinkDescriptor, ) -> Pin<Box<dyn Future<Output = Result<Option<Bytes>, CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Read and verify one prepared sink descriptor.

fn load_sink_artifact_intent<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, manifest: &'life1 CheckpointManifest, intent: &'life2 PreparedSinkArtifactIntent, ) -> Pin<Box<dyn Future<Output = Result<Option<Bytes>, CheckpointStoreError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Read and verify one begin-time sink artifact intent.