Enum DocumentMutation 

pub enum DocumentMutation {
    Snapshot(Vec<u8>),
    Incremental(Vec<u8>),
}

Meaning of a signed document payload. Keeping this tag inside [SignedOp::payload] makes snapshot-vs-incremental part of the bytes the device signs without changing the persisted SignedOp layout.

Variants

Snapshot(Vec<u8>)

A complete Automerge document used to seed a late joiner.

Incremental(Vec<u8>)

One Automerge incremental change set.

Implementations

impl DocumentMutation

pub fn kind(&self) -> DocumentMutationKind

Kind of this mutation independent of its bytes.

pub fn encode_frames(&self) -> Result<Vec<Vec<u8>>, DocumentMutationEncodeError>

Encode this mutation as the signed payloads that carry it: one frame when it fits in [DOCUMENT_SEGMENT_BYTES], otherwise one frame per segment. Each returned payload must be signed as its own envelope and the envelopes sent in order.

Errors

Returns [DocumentMutationEncodeError::TooLarge] when the Automerge bytes exceed [MAX_DOCUMENT_TRANSFER_BYTES].

impl DocumentMutation

pub fn visit_snapshot_encoding( bytes: &[u8], write: impl FnMut(&[u8]), ) -> Result<(), DocumentMutationEncodeError>

Visit the exact snapshot encoding without allocating a payload buffer. The visitor owns any destination allocation or digest state.

Errors

Returns [DocumentMutationEncodeError::TooLarge] when bytes exceed [MAX_DOCUMENT_MUTATION_BYTES].

pub fn encode(&self) -> Result<Vec<u8>, DocumentMutationEncodeError>

Encode the kind and Automerge bytes into the payload carried by one [SignedOp]. Use Self::encode_frames for mutations that may exceed a single frame.

Errors

Returns [DocumentMutationEncodeError::TooLarge] when the Automerge bytes exceed [MAX_DOCUMENT_MUTATION_BYTES].

pub fn decode(payload: &[u8]) -> Result<DocumentMutation, DocumentMutationError>

Decode a complete versioned document mutation, either a single frame or a payload reassembled from segments. Unprefixed payloads fail explicitly rather than being guessed to be an incremental update. Wire frames are checked with the tighter [crate::document_transfer::DocumentFrame::decode].

Errors

Returns [DocumentMutationError::MissingPrefix] for unprefixed bytes, [DocumentMutationError::Segmented] for one segment of a larger mutation, or [DocumentMutationError::UnknownKind] / [DocumentMutationError::Truncated] for a corrupt typed body.

pub fn data(&self) -> &[u8]

Borrow the underlying Automerge bytes independent of mutation kind.

Trait Implementations

impl Clone for DocumentMutation

fn clone(&self) -> DocumentMutation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentMutation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentMutation

fn deserialize<__D>( __deserializer: __D, ) -> Result<DocumentMutation, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DocumentMutation

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for DocumentMutation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DocumentMutation

impl StructuralPartialEq for DocumentMutation