Struct SyncEngine 

pub struct SyncEngine { /* private fields */ }

Coordinates document reconciliation and blob availability for a folder.

Implementations

impl SyncEngine

pub const fn new( folder_manager: FolderManager, blob_store: BlobStore, docs_engine: DocsEngine, topic_tracker: Option<TopicTracker>, ) -> Self

pub fn with_node_db(self, node_db: NodeDatabase) -> Self

Set the node database for checkpoint tracking.

pub fn from_node(node: &IrohNode, folder_manager: FolderManager) -> Self

pub async fn sync( &self, folder_id: NamespaceId, mode: SessionMode, ) -> Result<IntentHandle>

Start reconciling a managed folder.

Iroh Docs performs network reconciliation itself. This intent provides lifecycle, control, and aggregate transfer events around that process.

Errors

Returns an error if the folder is not managed locally.

pub async fn sync_with_params( &self, folder_id: NamespaceId, mode: SessionMode, params: SubscribeParams, ) -> Result<IntentHandle>

Start a synchronization intent with subscription filtering.

Errors

Returns an error if the folder is not managed locally or live sync cannot be started.

pub async fn subscribe( &self, folder_id: NamespaceId, params: SubscribeParams, ) -> Result<IntentHandle>

Subscribe to live changes in a folder.

Errors

Returns an error if the folder is not managed locally or live sync cannot be started.

pub async fn fetch( &self, folder_id: NamespaceId, strategy: FetchStrategy, ) -> Result<IntentHandle>

Fetch folder content using a full or filtered reconciliation strategy.

Peer-count filters are applied by callers that have availability observations. The document subscription still carries path, size, and count limits so the remote reconciliation remains bounded.

Errors

Returns an error if the folder is not managed locally or synchronization cannot be started.

pub async fn sync_with_filter( &self, folder_id: NamespaceId, mode: SessionMode, params: SubscribeParams, filter: FilterEngine, ) -> Result<IntentHandle>

Start a synchronization intent and filter emitted entries.

The document reconciliation remains content-addressed and is handled by iroh-docs; the filter controls which entries are reported to the automatic synchronization consumer.

Errors

Returns an error if the folder is not managed locally or live sync cannot be started.

Trait Implementations

impl Clone for SyncEngine

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.