Struct iroh_sync::store::memory::Store

pub struct Store { /* private fields */ }

Manages the replicas and authors for an instance.

Trait Implementations

impl Clone for Store

fn clone(&self) -> Store

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Store

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Store

fn default() -> Store

Returns the “default value” for a type.

impl Store for Store

fn content_hashes(&self) -> Result<Self::ContentHashesIter<'_>>

Get all content hashes of all replicas in the store.

type Instance = ReplicaStoreInstance

The specialized instance scoped to a Namespace.

type GetIter<'a> = RangeIterator<'a>

Iterator over entries in the store, returned from Self::get_many

type ContentHashesIter<'a> = ContentHashesIterator<'a>

Iterator over all content hashes in the store, returned from Self::content_hashes

type AuthorsIter<'a> = IntoIter<Result<Author, Error>>

Iterator over authors in the store, returned from Self::list_authors

type NamespaceIter<'a> = IntoIter<Result<NamespaceId, Error>>

Iterator over replica namespaces in the store, returned from Self::list_namespaces

type PeersIter<'a> = IntoIter<[u8; 32]>

Iterator over peers in the store for a document, returned from Self::get_sync_peers.

fn open_replica( &self, namespace: &NamespaceId ) -> Result<Option<Replica<Self::Instance>>>

Open a replica from this store.

fn close_replica(&self, namespace_id: &NamespaceId)

Close a replica.

fn list_namespaces(&self) -> Result<Self::NamespaceIter<'_>>

List all replica namespaces in this store.

fn get_author(&self, author: &AuthorId) -> Result<Option<Author>>

Get an author key from the store.

fn import_author(&self, author: Author) -> Result<()>

Import an author key pair.

fn list_authors(&self) -> Result<Self::AuthorsIter<'_>>

List all author keys in this store.

fn new_replica( &self, namespace: Namespace ) -> Result<Replica<ReplicaStoreInstance>>

Create a new replica for namespace and persist in this store.

fn remove_replica(&self, namespace: &NamespaceId) -> Result<()>

Remove a replica.

fn get_many( &self, namespace: NamespaceId, filter: GetFilter ) -> Result<Self::GetIter<'_>>

Get an iterator over entries of a replica.

fn get_one( &self, namespace: NamespaceId, author: AuthorId, key: impl AsRef<[u8]> ) -> Result<Option<SignedEntry>>

Get an entry by key and author.

fn register_useful_peer( &self, namespace: NamespaceId, peer: PeerIdBytes ) -> Result<()>

Register a peer that has been useful to sync a document.

fn get_sync_peers( &self, namespace: &NamespaceId ) -> Result<Option<Self::PeersIter<'_>>>

Get peers to use for syncing a document.

fn new_author<R: CryptoRngCore + ?Sized>(&self, rng: &mut R) -> Result<Author>

Create a new author key and persist it in the store.