Struct SyncManager 

pub struct SyncManager { /* private fields */ }

Available on crate feature sync only.

Orchestrator for sync operations between two PulseDB instances.

The SyncManager is a sidecar — it holds Arc<PulseDB> but doesn’t wrap it. Local database operations are completely unaffected by sync state.

Example

use std::sync::Arc;
use pulsedb::{PulseDB, Config};
use pulsedb::sync::{SyncManager, SyncConfig, InMemorySyncTransport};

let db = Arc::new(PulseDB::open("my.db", Config::default())?);
let (local_transport, _remote) = InMemorySyncTransport::new_pair();
let mut manager = SyncManager::new(db, Box::new(local_transport), SyncConfig::default());
manager.start().await?;
// ... sync runs in background ...
manager.stop().await?;

Implementations

impl SyncManager

pub fn new( db: Arc<PulseDB>, transport: Box<dyn SyncTransport>, config: SyncConfig, ) -> Self

Creates a new SyncManager.

Does NOT start sync — call start() or sync_once() to begin.

pub async fn start(&mut self) -> Result<(), SyncError>

Starts the background sync loop.

Performs a handshake with the remote peer, then spawns a background tokio task that pushes and pulls on the configured intervals.

pub async fn stop(&mut self) -> Result<(), SyncError>

Stops the background sync loop.

pub async fn sync_once(&mut self) -> Result<SyncStatus, SyncError>

Performs a single push+pull sync cycle (no background task needed).

Useful for testing or manual sync triggers.

pub async fn initial_sync( &mut self, progress: Option<Box<dyn SyncProgressCallback>>, ) -> Result<(), SyncError>

Performs initial sync — pulls all remote changes in batches.

Call this before start() to catch up from a cold start.

pub fn status(&self) -> SyncStatus

Returns the current sync status.