Struct FolderManager 

pub struct FolderManager { /* private fields */ }

Implementations

impl FolderManager

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

pub async fn create(&self, mode: SyncMode) -> Result<SyncwebFolder>

Errors

Returns an error if the folder namespace cannot be created or initialized.

pub async fn join( &self, ticket_str: impl AsRef<str>, mode: SyncMode, ) -> Result<SyncwebFolder>

Errors

Returns an error if the folder ticket cannot be joined or parsed.

pub async fn subscribe_public(&self, ticket: &BlobTicket) -> Result<Hash>

Subscribe to a public blob ticket. Fetches the blob and returns its hash. Does NOT create an Iroh doc namespace.

Errors

Returns an error if the blob cannot be fetched.

pub async fn accept(&self, namespace_id: NamespaceId) -> Result<SyncwebFolder>

Errors

Returns an error if the folder namespace cannot be accepted.

pub async fn announce_namespace(&self, namespace_id: NamespaceId)

Announce a namespace to the topic tracker if not already announced. Idempotent — safe to call multiple times for the same namespace.

pub async fn subscriptions(&self) -> Vec<Hash>

Return all managed public subscription hashes.

pub async fn seed_subscriptions(&self, hashes: impl IntoIterator<Item = Hash>)

Seed the subscription set from persisted hashes (e.g. loaded from SQLite on startup).

pub async fn drop_subscription(&self, hash: &Hash)

Drop (unsubscribe from) a public blob subscription.

pub async fn has_subscription(&self, hash: &Hash) -> bool

Check whether a public subscription for the given hash exists.

pub async fn drop(&self, namespace_id: NamespaceId) -> Result<()>

Errors

Returns an error if the folder namespace cannot be dropped.

pub async fn drop_when_ready(&self, namespace_id: NamespaceId) -> Result<()>

Drop a namespace, retrying briefly while its live session replica is still closing.

Errors

Returns an error if the folder namespace cannot be dropped.

pub async fn delete_folder_files(path: &Path) -> Result<()>

Delete the local files of a materialized folder at path.

Refuses to delete a filesystem root or the current working directory; only the folder’s registered path may be deleted.

Errors

Returns an error if the path cannot be resolved, is unsafe, or cannot be deleted.

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

Errors

Returns an error if the folders cannot be listed.

pub async fn get(&self, namespace_id: NamespaceId) -> Result<SyncwebFolder>

Return a managed folder, loading locally available namespaces first.

Errors

Returns an error if the local namespace list cannot be read.

pub async fn ticket( &self, namespace_id: NamespaceId, writable: bool, ) -> Result<DocTicket>

Errors

Returns an error if the ticket cannot be generated.

Trait Implementations

impl Clone for FolderManager

fn clone(&self) -> FolderManager

Returns a duplicate of the value.

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

Performs copy-assignment from source.