Struct CheckpointFile 

pub struct CheckpointFile {
    pub database_type: String,
    pub checkpoint: Value,
    pub phase: SyncPhase,
    pub created_at: DateTime<Utc>,
}

Storage-agnostic checkpoint file wrapper.

This struct wraps database-specific checkpoints with metadata for storage and retrieval. The format is designed to be:

• Self-describing (includes database_type field)
• Extensible (uses JSON Value for checkpoint data)
• Storage-agnostic (can be saved to local fs, remote storage, etc.)

File Format

{
    "database_type": "mongodb",
    "checkpoint": {
        "resume_token": [1, 2, 3],
        "timestamp": "2024-01-01T00:00:00Z"
    },
    "phase": "FullSyncStart",
    "created_at": "2024-01-01T00:00:00Z"
}

Fields

database_type: String

Database type identifier (e.g., “mongodb”, “neo4j”)

checkpoint: Value

Serialized checkpoint data as JSON Value

phase: SyncPhase

Sync phase when this checkpoint was created

created_at: DateTime<Utc>

Timestamp when this checkpoint file was created

Implementations

impl CheckpointFile

pub fn new<C: Checkpoint>(checkpoint: &C, phase: SyncPhase) -> Result<Self>

Create new checkpoint file from database-specific checkpoint.

Arguments

• checkpoint - Database-specific checkpoint implementing Checkpoint trait
• phase - Sync phase (FullSyncStart, FullSyncEnd)

Example

let checkpoint = MongoDBCheckpoint { ... };
let file = CheckpointFile::new(&checkpoint, SyncPhase::FullSyncStart)?;

pub fn parse<C: Checkpoint>(&self) -> Result<C>

Parse checkpoint into database-specific type.

Validates that the stored database_type matches the expected type C.

Errors

Returns an error if:

• The database_type doesn’t match C::DATABASE_TYPE
• The checkpoint data can’t be deserialized into type C

Example

let file: CheckpointFile = /* loaded from file */;
let checkpoint: MongoDBCheckpoint = file.parse()?;

pub fn database_type(&self) -> &str

Get the database type of this checkpoint file.

pub fn phase(&self) -> &SyncPhase

Get the phase when this checkpoint was created.

pub fn created_at(&self) -> DateTime<Utc>

Get the timestamp when this checkpoint file was created.

Trait Implementations

impl Clone for CheckpointFile

fn clone(&self) -> CheckpointFile

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CheckpointFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CheckpointFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CheckpointFile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.