Struct iroh_docs::sync::ReplicaInfo

pub struct ReplicaInfo { /* private fields */ }

In memory information about an open replica.

Implementations

impl ReplicaInfo

pub fn new(capability: Capability) -> Self

Create a new replica.

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

Subscribe to insert events.

When subscribing to a replica, you must ensure that the corresponding [async_channel::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 merge_capability( &mut self, capability: Capability ) -> Result<bool, CapabilityError>

Merge a capability.

The capability must refer to the the same namespace, otherwise an error will be returned.

This will upgrade the replica’s capability when passing a Capability::Write. It is a no-op if capability is a Capability::Read`.

Trait Implementations

impl Debug for ReplicaInfo

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

Formats the value using the given formatter.