Struct SyncwebFolder 

pub struct SyncwebFolder { /* private fields */ }

Implementations

impl SyncwebFolder

pub fn new( doc: Doc, author: AuthorId, blob_store: BlobStore, docs_engine: DocsEngine, sync_mode: SyncMode, ) -> Self

pub async fn drop_namespace(&self) -> Result<()>

Drop this folder’s namespace from the docs engine.

Errors

Returns an error if the namespace cannot be dropped.

pub const fn namespace_id(&self) -> NamespaceId

pub const fn author(&self) -> AuthorId

pub const fn mode(&self) -> SyncMode

pub const fn doc(&self) -> &Doc

pub const fn docs_engine(&self) -> &DocsEngine

pub async fn grant(&self, node_id: PublicKey, capability: Capability)

pub async fn capability(&self, node_id: PublicKey) -> Option<Capability>

pub async fn can_write_as(&self, node_id: PublicKey) -> bool

pub async fn has_local(&self, hash: Hash) -> Result<bool>

Check whether a blob is complete in this folder’s local store.

Errors

Returns an error if the blob store cannot be queried.

pub async fn set_metadata_only(&self) -> Result<()>

Track this folder’s metadata without fetching content into the local store (user stories 1 and 4). Doc entries still sync, but iroh-docs’ download policy keeps the blobs remote until an explicit download.

Errors

Returns an error if the download policy cannot be persisted.

pub async fn clear_metadata_only(&self) -> Result<()>

Restore the default download policy (fetch all referenced content during doc sync).

Errors

Returns an error if the download policy cannot be persisted.

pub async fn is_metadata_only(&self) -> Result<bool>

Whether this folder is currently in metadata-only mode (content stays out of the local store until an explicit download).

Errors

Returns an error if the download policy cannot be read.

pub async fn content_entries(&self) -> Result<Vec<Entry>>

List the folder’s content entries, excluding sys/ metadata keys.

Used by stats, verify, and health-reporting paths so the “iterate the latest per-key entries, skip system keys” pattern lives in one place.

Errors

Returns an error if the document query fails.

pub async fn set_blob( &self, key: impl AsRef<[u8]>, value: impl AsRef<[u8]>, ) -> Result<Hash>

Errors

Returns an error if the blob fails to be stored or set.

pub async fn set_blob_ref( &self, key: impl AsRef<[u8]>, hash: Hash, size: u64, ) -> Result<()>

Store an existing blob reference in this folder.

Errors

Returns an error if the folder is read-only, the blob is unavailable, or the document entry cannot be written.

pub async fn delete_entry(&self, key: impl AsRef<[u8]>) -> Result<()>

Delete a folder entry.

Errors

Returns an error if the folder is read-only or the document entry cannot be deleted.

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

Errors

Returns an error if the folder ticket cannot be created.

pub async fn publish_blob( &self, endpoint: EndpointAddr, hash: Hash, ) -> Result<BlobTicket>

Create an unauthenticated ticket for a blob in this folder and pin it while it is publicly shared.

Errors

Returns an error if the blob is unavailable or cannot be pinned.

pub async fn unpublish_blob(&self, hash: Hash) -> Result<()>

Remove the public-sharing pin from a folder blob.

Existing blob tickets are capabilities and remain usable while another tag or active transfer retains the blob.

Errors

Returns an error if the public-sharing pin cannot be removed.

pub async fn pin_all_content(&self) -> Result<usize>

Pin every blob currently referenced by the folder’s document so the shared content is retained (not evicted by garbage collection).

Returns the number of distinct blobs pinned.

Errors

Returns an error if the folder’s entries cannot be read or a pin fails.

pub async fn unpin_all_content(&self) -> Result<usize>

Remove the retention pins placed by pin_all_content for every blob currently referenced by the folder’s document.

Returns the number of pins removed.

Errors

Returns an error if the folder’s entries cannot be read or an unpin fails.

Trait Implementations

impl Clone for SyncwebFolder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl FolderLike for SyncwebFolder

fn namespace_id(&self) -> String

fn label(&self) -> String

fn kind(&self) -> &'static str

fn path(&self) -> Option<&Path>

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

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