Enum ExportMode

#[non_exhaustive]
pub enum ExportMode<'a> {
    Snapshot,
    Updates {
        from: Cow<'a, VersionVector>,
    },
    UpdatesInRange {
        spans: Cow<'a, [IdSpan]>,
    },
    ShallowSnapshot(Cow<'a, Frontiers>),
    StateOnly(Option<Cow<'a, Frontiers>>),
    SnapshotAt {
        version: Cow<'a, Frontiers>,
    },
}

The mode of the export.

Loro CRDT internally consists of two parts: document history and current document state. The export modes offer various options to meet different requirements.

• CRDT property: Documents maintain consistent states when they receive the same set of updates.
• In real-time collaboration, peers typically only need to synchronize updates (operations/history) to achieve consistency.

Update Export

• Exports only the history part, containing multiple operations.
• Suitable for real-time collaboration scenarios where peers only need to synchronize updates.

Snapshot Export

Default Snapshot

• Includes complete history and current full state.

Shallow Snapshot

• Contains the complete current state.
• Retains partial history starting from a specified version.

State-only Snapshot

• Exports the state of the target version.
• Includes a minimal set of operation history.

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.

Snapshot

It contains the full history and the current state of the document.

Updates

It contains the history since the from version vector.

Fields

from: Cow<'a, VersionVector>

UpdatesInRange

This mode exports the history in the specified range.

Fields

spans: Cow<'a, [IdSpan]>

ShallowSnapshot(Cow<'a, Frontiers>)

The shallow snapshot only contains the history since the target frontiers

StateOnly(Option<Cow<'a, Frontiers>>)

The state only snapshot exports the state of the target version with a minimal set of history (a few ops).

It’s a shallow snapshot with depth=1 at the target version. If the target version is None, it will use the latest version as the target version.

SnapshotAt

The snapshot at the specified frontiers. It contains the full history till the target frontiers and the state at the target frontiers.

Fields

version: Cow<'a, Frontiers>

Implementations

impl<'a> ExportMode<'a>

pub fn snapshot() -> Self

It contains the full history and the current state of the document.

pub fn updates(from: &'a VersionVector) -> Self

It contains the history since the from version vector.

pub fn updates_owned(from: VersionVector) -> Self

It contains the history since the from version vector.

pub fn all_updates() -> Self

It contains all the history of the document.

pub fn updates_in_range(spans: impl Into<Cow<'a, [IdSpan]>>) -> Self

This mode exports the history in the specified range.

pub fn shallow_snapshot(frontiers: &'a Frontiers) -> Self

The shallow snapshot only contains the history since the target frontiers.

pub fn shallow_snapshot_owned(frontiers: Frontiers) -> Self

The shallow snapshot only contains the history since the target frontiers.

pub fn shallow_snapshot_since(id: ID) -> Self

The shallow snapshot only contains the history since the target frontiers.

pub fn state_only(frontiers: Option<&'a Frontiers>) -> Self

The state only snapshot exports the state of the target version with a minimal set of history (a few ops).

It’s a shallow snapshot with depth=1 at the target version. If the target version is None, it will use the latest version as the target version.

pub fn snapshot_at(frontiers: &'a Frontiers) -> Self

The snapshot at the specified frontiers. It contains the full history till the target frontiers and the state at the target frontiers.

pub fn updates_till(vv: &VersionVector) -> ExportMode<'static>

This mode exports the history within the specified version vector.

Trait Implementations

impl<'a> Clone for ExportMode<'a>

fn clone(&self) -> ExportMode<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ExportMode<'a>

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

Formats the value using the given formatter.