Struct SyncPlugin 

pub struct SyncPlugin<FS: AsyncFileSystem + Clone> { /* private fields */ }

Plugin that owns all CRDT state and handles sync commands.

Generic over FS (filesystem), but erased to Arc<dyn WorkspacePlugin> at registration. The FS: Clone bound is required for constructing Workspace<FS> and Exporter<FS>.

Implementations

impl<FS: AsyncFileSystem + Clone + 'static> SyncPlugin<FS>

pub fn new(fs: FS, storage: Arc<dyn CrdtStorage>) -> Self

Create with fresh empty CRDT state.

pub fn load(fs: FS, storage: Arc<dyn CrdtStorage>) -> CoreResult<Self>

Create by loading existing CRDT state from storage.

pub fn with_instances( fs: FS, workspace_crdt: Arc<WorkspaceCrdt>, body_docs: Arc<BodyDocManager>, storage: Arc<dyn CrdtStorage>, ) -> Self

Create with pre-configured CRDT instances.

Use this when consumers need Arc handles for event callbacks before plugin registration (e.g., the WASM backend).

pub fn workspace_crdt(&self) -> Arc<WorkspaceCrdt>

Get the workspace CRDT handle.

pub fn body_docs(&self) -> Arc<BodyDocManager>

Get the body document manager handle.

pub fn sync_handler(&self) -> Arc<SyncHandler<FS>>

Get the sync handler handle.

pub fn sync_manager(&self) -> Arc<RustSyncManager<FS>>

Get the sync manager handle.

pub fn storage(&self) -> Arc<dyn CrdtStorage>

Get the storage handle.

Trait Implementations

impl<FS: AsyncFileSystem + Clone + Send + Sync + 'static> Plugin for SyncPlugin<FS>

fn id(&self) -> PluginId

Unique identifier for this plugin.

fn manifest(&self) -> PluginManifest

Declarative manifest describing this plugin’s metadata and UI contributions.

fn init<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 PluginContext, ) -> Pin<Box<dyn Future<Output = Result<(), PluginError>> + Send + 'async_trait>>

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

Initialize the plugin with the given context.

fn shutdown<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), PluginError>> + Send + 'async_trait>>

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

Shut down the plugin, releasing any resources.

impl<FS: AsyncFileSystem + Clone + Send + Sync + 'static> WorkspacePlugin for SyncPlugin<FS>

fn on_workspace_opened<'life0, 'life1, 'async_trait>( &'life0 self, event: &'life1 WorkspaceOpenedEvent, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

Called when a workspace is opened.

fn handle_command<'life0, 'life1, 'async_trait>( &'life0 self, cmd: &'life1 str, params: JsonValue, ) -> Pin<Box<dyn Future<Output = Option<Result<JsonValue, PluginError>>> + Send + 'async_trait>>

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

Handle a plugin-specific command.

fn notify_workspace_modified<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

Called after a workspace-modifying operation completes.

fn on_body_doc_renamed<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, old_path: &'life1 str, new_path: &'life2 str, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

Called when a body document needs to be renamed (file was moved/renamed).

fn on_body_doc_deleted<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

Called when a body document should be deleted.

fn track_file_for_sync<'life0, 'life1, 'async_trait>( &'life0 self, canonical_path: &'life1 str, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

Called after a file operation to track CRDT metadata for echo detection.

fn get_canonical_path(&self, storage_path: &str) -> Option<String>

Resolve a canonical path from a storage path.

fn track_content_for_sync(&self, canonical_path: &str, content: &str)

Track body content for echo detection.

fn get_file_title(&self, canonical_path: &str) -> Option<String>

Get the title for a file from CRDT metadata.

fn on_workspace_closed<'life0, 'life1, 'async_trait>( &'life0 self, event: &'life1 WorkspaceClosedEvent, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

Called when a workspace is closed.

fn on_workspace_changed<'life0, 'life1, 'async_trait>( &'life0 self, event: &'life1 WorkspaceChangedEvent, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

Called when workspace metadata changes.

fn on_workspace_committed<'life0, 'life1, 'async_trait>( &'life0 self, event: &'life1 WorkspaceCommittedEvent, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

Called when a workspace is committed (e.g., git commit or sync checkpoint).

fn get_config<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Option<Value>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Get this plugin’s configuration (if any).

fn set_config<'life0, 'async_trait>( &'life0 self, _config: Value, ) -> Pin<Box<dyn Future<Output = Result<(), PluginError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Update this plugin’s configuration.