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 create( docs_engine: DocsEngine, blob_store: BlobStore, sync_mode: SyncMode, ) -> Result<Self>

Create a new folder by allocating a namespace in the docs engine.

Errors

Returns an error if the namespace cannot be created or the default author cannot be retrieved.

pub async fn accept( docs_engine: DocsEngine, blob_store: BlobStore, namespace_id: NamespaceId, ) -> Result<Self>

Accept a locally available folder by namespace ID.

Errors

Returns an error if the namespace cannot be opened.

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 create_snapshot( &self, description: Option<String>, ) -> Result<Snapshot>

Create a content-addressed snapshot of this folder.

Errors

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

pub async fn restore_snapshot(&self, snapshot: &Snapshot) -> Result<()>

Restore this folder’s document entries from a snapshot.

Errors

Returns an error if the snapshot belongs to another folder or content is unavailable.

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

List snapshots stored in the local blob store.

Errors

Returns an error if snapshot manifests cannot be read.

pub async fn delete_snapshot(&self, snapshot_id: SnapshotId) -> Result<()>

Delete a snapshot and release its pins.

Errors

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

pub fn diff_snapshots( &self, first: &Snapshot, second: &Snapshot, ) -> Result<SnapshotDiff>

Compare two snapshots.

Errors

Returns an error if either snapshot is invalid.

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, endpoint: EndpointAddr, 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.

Trait Implementations

impl Clone for SyncwebFolder

fn clone(&self) -> SyncwebFolder

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,