Enum iroh_docs::engine::LiveEvent

pub enum LiveEvent {
    InsertLocal {
        entry: Entry,
    },
    InsertRemote {
        from: PublicKey,
        entry: Entry,
        content_status: ContentStatus,
    },
    ContentReady {
        hash: Hash,
    },
    PendingContentReady,
    NeighborUp(PublicKey),
    NeighborDown(PublicKey),
    SyncFinished(SyncEvent),
}

Available on crate feature engine only.

Events informing about actions of the live sync progress.

Variants

InsertLocal

A local insertion.

Fields

entry: Entry

The inserted entry.

InsertRemote

Received a remote insert.

Fields

from: PublicKey

The peer that sent us the entry.

entry: Entry

The inserted entry.

content_status: ContentStatus

If the content is available at the local node

ContentReady

The content of an entry was downloaded and is now available at the local node

Fields

hash: Hash

The content hash of the newly available entry content

PendingContentReady

All pending content is now ready.

This event signals that all queued content downloads from the last sync run have either completed or failed.

It will only be emitted after a Self::SyncFinished event, never before.

Receiving this event does not guarantee that all content in the document is available. If blobs failed to download, this event will still be emitted after all operations completed.

NeighborUp(PublicKey)

We have a new neighbor in the swarm.

NeighborDown(PublicKey)

We lost a neighbor in the swarm.

SyncFinished(SyncEvent)

A set-reconciliation sync finished.

Trait Implementations

impl Clone for LiveEvent

fn clone(&self) -> LiveEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LiveEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LiveEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LiveEvent

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

Formats the value using the given formatter.

impl PartialEq for LiveEvent

fn eq(&self, other: &LiveEvent) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LiveEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for LiveEvent

impl StructuralPartialEq for LiveEvent