Struct SnapshotStore 

pub struct SnapshotStore { /* private fields */ }

Persists snapshot manifests and pins all content referenced by them.

Implementations

impl SnapshotStore

pub const fn new(blobs: BlobStore) -> Self

pub const fn with_docs(blobs: BlobStore, docs: DocsEngine) -> Self

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

pub async fn create_snapshot( &self, namespace_id: Option<NamespaceId>, entries: Vec<SnapshotEntry>, description: Option<String>, ) -> Result<Snapshot>

Create and persist a snapshot from existing content references.

Errors

Returns an error if a referenced blob is unavailable or the manifest cannot be stored.

pub async fn create_from_path( &self, source_value: impl AsRef<Path>, threads: usize, description: Option<String>, ) -> Result<Snapshot>

Create a snapshot from a local directory.

Files are imported into the content-addressed store once; the snapshot itself only stores references to those blobs.

Errors

Returns an error if scanning, importing, or manifest storage fails.

pub async fn create_for_folder( &self, folder: &SyncwebFolder, description: Option<String>, ) -> Result<Snapshot>

Create a snapshot of the latest entries in a synchronized folder.

Errors

Returns an error if entries cannot be read or referenced blobs are missing.

pub async fn restore_to_path( &self, snapshot: &Snapshot, destination_value: impl AsRef<Path>, ) -> Result<Vec<PathBuf>>

Restore a snapshot to a local directory, removing files not present in it.

Errors

Returns an error if referenced content is unavailable or materialization fails.

pub async fn restore_for_folder( &self, folder: &SyncwebFolder, snapshot: &Snapshot, ) -> Result<()>

Restore a snapshot by updating a synchronized folder’s document entries.

Errors

Returns an error if the snapshot belongs to another folder, content is missing, or document updates fail.

pub async fn list(&self) -> Result<Vec<Snapshot>>

List all locally pinned snapshots.

Errors

Returns an error if snapshot pins or manifests cannot be read.

pub async fn load(&self, id: SnapshotId) -> Result<Snapshot>

Load a snapshot by its content-addressed identifier.

Errors

Returns an error if the snapshot is not pinned or cannot be decoded.

pub async fn delete(&self, id: SnapshotId) -> Result<()>

Remove a snapshot and release its pins.

Errors

Returns an error if the snapshot cannot be found or pins cannot be removed.

pub async fn ticket( &self, endpoint: &Endpoint, snapshot: &Snapshot, ) -> Result<BlobTicket>

Create a ticket for a snapshot manifest.

Errors

Returns an error if the snapshot is not locally available.

pub async fn import_ticket( &self, endpoint: &Endpoint, ticket: &BlobTicket, ) -> Result<Snapshot>

Fetch a shared snapshot manifest and all referenced content blobs.

Errors

Returns an error if the ticket, manifest, or any content blob cannot be fetched.

Trait Implementations

impl Clone for SnapshotStore

fn clone(&self) -> SnapshotStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.