Enum StateEventContent 

#[non_exhaustive]
pub enum StateEventContent {
    #[non_exhaustive]
    PeerSynced {
        peer_id: PeerId,
        discovery_key: FeedDiscoveryKey,
        contiguous_length: u64,
    },
    #[non_exhaustive]
    RemotePeerSynced {
        peer_id: PeerId,
        discovery_key: FeedDiscoveryKey,
        contiguous_length: u64,
    },
    #[non_exhaustive]
    PeerChanged {
        peer_id: PeerId,
        discovery_key: FeedDiscoveryKey,
        replaced_discovery_key: Option<FeedDiscoveryKey>,
    },
    #[non_exhaustive]
    DocumentInitialized {
        new_document: bool,
        child: bool,
        parent_document_ids: Vec<DocumentId>,
    },
    #[non_exhaustive]
    DocumentChanged {
        change_id: Option<Vec<u8>>,
        patches: Vec<Patch>,
    },
}

Content of a StateEvent

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

#[non_exhaustive]

PeerSynced

Remote peer’s data was synced to local document

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

peer_id: PeerId

Id of the peer whose data was synced

discovery_key: FeedDiscoveryKey

Discovery key of peer’s feed

contiguous_length: u64

Length that was synced

#[non_exhaustive]

RemotePeerSynced

Remote peer got local data

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

peer_id: PeerId

Id of the peer that was synced

discovery_key: FeedDiscoveryKey

Discovery key of the feed

contiguous_length: u64

Length that was synced

#[non_exhaustive]

PeerChanged

Peer’s feed got replaced. NB: Listen to this for in-memory peers and if peer_id matches local peer_id, store (and replace) value from reattach_secret() so that it can be given back when re-attaching the document.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

peer_id: PeerId

Id of the peer that was changed

discovery_key: FeedDiscoveryKey

New discovery key

replaced_discovery_key: Option<FeedDiscoveryKey>

Discovery key that was replaced

#[non_exhaustive]

DocumentInitialized

Document was initialized and is now ready to transact with.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

new_document: bool

If true, this is a brand new document. If false, an existing one.

child: bool

Whether this document is a child

parent_document_ids: Vec<DocumentId>

All the document ids that are parents to this document. This can have multiple values if another parent of the document is being proxied in this peermerge.

#[non_exhaustive]

DocumentChanged

Document was changed

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

change_id: Option<Vec<u8>>

Optional change id if given when creating a document or transacting with it. NB: This can only come with local changes. Remote peers’ change ids are not transmitted over-the-wire.

patches: Vec<Patch>

Full automerge patches of the change.

Trait Implementations

impl Clone for StateEventContent

fn clone(&self) -> StateEventContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StateEventContent

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

Formats the value using the given formatter.