Struct IncrementalCheckpointManager 

pub struct IncrementalCheckpointManager { /* private fields */ }

Incremental checkpoint manager.

This manager creates and manages incremental checkpoints using directory-based snapshots with metadata tracking.

Implementations

impl IncrementalCheckpointManager

pub fn new(config: CheckpointConfig) -> Result<Self, IncrementalCheckpointError>

Creates a new incremental checkpoint manager.

Errors

Returns an error if the configuration is invalid or directory creation fails.

pub fn config(&self) -> &CheckpointConfig

Returns the configuration.

pub fn set_epoch(&self, epoch: u64)

Sets the current epoch.

pub fn epoch(&self) -> u64

Returns the current epoch.

pub fn put( &mut self, key: &[u8], value: &[u8], ) -> Result<(), IncrementalCheckpointError>

Puts a key-value pair into the state.

Errors

Returns an error if the write fails.

pub fn delete(&mut self, key: &[u8]) -> Result<(), IncrementalCheckpointError>

Deletes a key from the state.

Errors

Returns an error if the delete fails.

pub fn set_source_offset(&mut self, source: String, offset: u64)

Sets a source offset for exactly-once semantics.

pub fn source_offsets(&self) -> &HashMap<String, u64>

Returns the source offsets.

pub fn set_watermark(&mut self, watermark: i64)

Sets the current watermark.

pub fn watermark(&self) -> Option<i64>

Returns the current watermark.

pub fn latest_checkpoint_id(&self) -> Option<u64>

Returns the latest checkpoint ID.

pub fn should_checkpoint(&self) -> bool

Checks if it’s time to create a checkpoint.

pub fn create_checkpoint( &mut self, wal_position: u64, ) -> Result<IncrementalCheckpointMetadata, IncrementalCheckpointError>

Creates a new incremental checkpoint.

This creates a checkpoint of the current state using directory-based snapshots.

Errors

Returns an error if checkpoint creation fails.

pub fn create_checkpoint_with_state( &mut self, wal_position: u64, source_offsets: HashMap<String, u64>, watermark: Option<i64>, state_data: &[u8], ) -> Result<IncrementalCheckpointMetadata, IncrementalCheckpointError>

Creates a checkpoint with additional state data.

Errors

Returns an error if checkpoint creation fails.

pub fn find_latest_checkpoint( &self, ) -> Result<Option<IncrementalCheckpointMetadata>, IncrementalCheckpointError>

Finds the latest checkpoint.

Errors

Returns an error if reading checkpoint metadata fails.

pub fn load_checkpoint_metadata( &self, id: u64, ) -> Result<Option<IncrementalCheckpointMetadata>, IncrementalCheckpointError>

Loads checkpoint metadata by ID.

Errors

Returns an error if reading metadata fails.

pub fn load_checkpoint_state( &self, id: u64, ) -> Result<Vec<u8>, IncrementalCheckpointError>

Loads state data from a checkpoint.

Errors

Returns an error if reading state data fails.

pub fn list_checkpoints( &self, ) -> Result<Vec<IncrementalCheckpointMetadata>, IncrementalCheckpointError>

Lists all checkpoints sorted by ID (newest first).

Errors

Returns an error if reading checkpoints fails.

pub fn cleanup_old_checkpoints(&self) -> Result<(), IncrementalCheckpointError>

Cleans up old checkpoints beyond the retention limit.

Errors

Returns an error if cleanup fails.

pub fn cleanup_old_checkpoints_keep( &self, keep_count: usize, ) -> Result<(), IncrementalCheckpointError>

Cleans up old checkpoints, keeping only keep_count most recent.

Errors

Returns an error if cleanup fails.

pub fn delete_checkpoint( &mut self, id: u64, ) -> Result<(), IncrementalCheckpointError>

Deletes a specific checkpoint.

Errors

Returns an error if deletion fails.