Enum dittolive_ditto::prelude::LiveQueryEvent

pub enum LiveQueryEvent {
    Initial,
    Update {
        old_documents: Vec<BoxedDocument>,
        insertions: Box<[usize]>,
        deletions: Box<[usize]>,
        updates: Box<[usize]>,
        moves: Vec<LiveQueryMove>,
    },
}

Describes the different types of event that you can receive when dealing with live queries.

Variants

Initial

The first event that will be delivered and it will only be delivered once.

Update

Fields

old_documents: Vec<BoxedDocument>

insertions: Box<[usize]>

deletions: Box<[usize]>

updates: Box<[usize]>

moves: Vec<LiveQueryMove>

This event will be delivered each time the results of the provided query change. It contains information about the set of documents that previously matched the query before the update, along with information about what documents have been inserted, deleted, updated, or moved, as part of the set of matching documents.

Implementations

impl LiveQueryEvent

pub fn hash(&self, docs: &[BoxedDocument]) -> Result<u64, DittoError>

Return an hash of a document

pub fn hash_mnemonic(&self, docs: &[BoxedDocument]) -> Result<String, DittoError>

Return the hash the Documents mnemonic.

Trait Implementations

impl Debug for LiveQueryEvent

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

Formats the value using the given formatter.