Struct iroh_sync::sync::Replica

pub struct Replica<S: Store<SignedEntry> + PublicKeyStore> { /* private fields */ }

Local representation of a mutable, synchronizable key-value store.

Implementations

impl<S: Store<SignedEntry> + PublicKeyStore + 'static> Replica<S>

pub fn new(namespace: Namespace, store: S) -> Self

Create a new replica.

pub fn subscribe(&mut self, sender: Sender<Event>)

Subcribe to insert events.

When subscribing to a replica, you must ensure that the corresponding flume::Receiver is received from in a loop. If not receiving, local and remote inserts will hang waiting for the receiver to be received from.

pub fn unsubscribe(&mut self, sender: &Sender<Event>)

Explicitly unsubscribe a sender.

Simply dropping the receiver is fine too. If you cloned a single sender to subscribe to multiple replicas, you can use this method to explicitly unsubscribe the sender from this replica without having to drop the receiver.

pub fn subscribers_count(&self) -> usize

Get the number of current event subscribers.

pub fn set_content_status_callback(&mut self, cb: ContentStatusCallback) -> bool

Set the content status callback.

Only one callback can be active at a time. If a previous callback was registered, this will return false.

pub fn closed(&self) -> bool

Returns true if the replica is closed.

If a replica is closed, no further operations can be performed. A replica cannot be closed manually, it must be closed via store::Store::close_replica or store::Store::remove_replica

pub fn insert( &mut self, key: impl AsRef<[u8]>, author: &Author, hash: Hash, len: u64 ) -> Result<usize, InsertError<S>>

Insert a new record at the given key.

The entry will by signed by the provided author. The len must be the byte length of the data identified by hash.

Returns the number of entries removed as a consequence of this insertion, or an error either if the entry failed to validate or if a store operation failed.

pub fn delete_prefix( &mut self, prefix: impl AsRef<[u8]>, author: &Author ) -> Result<usize, InsertError<S>>

Delete entries that match the given author and key prefix.

This inserts an empty entry with the key set to prefix, effectively clearing all other entries whose key starts with or is equal to the given prefix.

Returns the number of entries deleted.

pub fn insert_remote_entry( &mut self, entry: SignedEntry, received_from: PeerIdBytes, content_status: ContentStatus ) -> Result<usize, InsertError<S>>

Insert an entry into this replica which was received from a remote peer.

This will verify both the namespace and author signatures of the entry, emit an on_insert event, and insert the entry into the replica store.

Returns the number of entries removed as a consequence of this insertion, or an error if the entry failed to validate or if a store operation failed.

pub fn hash_and_insert( &mut self, key: impl AsRef<[u8]>, author: &Author, data: impl AsRef<[u8]> ) -> Result<Hash>

Hashes the given data and inserts it.

This does not store the content, just the record of it. Returns the calculated hash.

pub fn id(&self, key: impl AsRef<[u8]>, author: &Author) -> RecordIdentifier

Get the identifier for an entry in this replica.

pub fn sync_initial_message(&self) -> Result<Message<SignedEntry>>

Create the initial message for the set reconciliation flow with a remote peer.

pub fn sync_process_message( &mut self, message: Message<SignedEntry>, from_peer: PeerIdBytes, state: &mut SyncOutcome ) -> Result<Option<Message<SignedEntry>>, Error>

Process a set reconciliation message from a remote peer.

Returns the next message to be sent to the peer, if any.

pub fn namespace(&self) -> NamespaceId

Get the namespace identifier for this Replica.

pub fn secret_key(&self) -> Namespace

Get the byte represenation of the Namespace key for this replica.

Trait Implementations

impl<S: Store<SignedEntry> + PublicKeyStore> Debug for Replica<S>

where Namespace: Debug, Peer<SignedEntry, S>: Debug, Subscribers: Debug, bool: Debug,

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

Formats the value using the given formatter.