Enum ChangeEvent 

pub enum ChangeEvent {
    Create {
        path: Box<str>,
        data: Value,
    },
    Update {
        path: Box<str>,
        data: Value,
        old_data: Option<Value>,
    },
    Delete {
        path: Box<str>,
        old_data: Option<Value>,
    },
    Lock {
        path: Box<str>,
        data: Value,
    },
    Unlock {
        path: Box<str>,
        data: Value,
    },
    Ready {
        path: Box<str>,
        data: Option<Value>,
    },
    Replace {
        path: Box<str>,
        data: Option<Value>,
    },
}

Real-time change event emitted when a document is created, updated, or deleted.

Variants

Create

A new document was created

Fields

path: Box<str>

Full path to the document (e.g., “posts/abc123” or “posts/abc123/comments/xyz789”)

data: Value

Full document data

Update

An existing document was updated

Fields

path: Box<str>

Full path to the document

data: Value

Full updated document data

old_data: Option<Value>

Previous document data (for incremental aggregate computation)

Delete

A document was deleted

Fields

path: Box<str>

Full path to the document

old_data: Option<Value>

Document data before deletion (for incremental aggregate computation)

Lock

A lock was acquired on a document path

Fields

path: Box<str>

Full path to the locked document

data: Value

Lock metadata (userId, mode)

Unlock

A lock was released on a document path

Fields

path: Box<str>

Full path to the unlocked document

data: Value

Unlock metadata (userId)

Ready

Signals that all initial documents have been yielded for a subscription

Fields

path: Box<str>

Subscription path

data: Option<Value>

Optional initial dataset

Replace

A complete result set replacing everything the subscriber holds.

Distinct from ChangeEvent::Ready, which is the one-shot initial-snapshot signal a client resolves its loading state on, and from ChangeEvent::Update, which a client merges as a delta. A min/max aggregate cannot express its recompute as either: the recompute yields the whole group set, so a group that emptied is simply absent rather than zeroed, and merging would keep it forever.

Fields

path: Box<str>

Subscription path

data: Option<Value>

The complete new dataset

Implementations

impl ChangeEvent

pub fn path(&self) -> &str

Get the full path from this event.

pub fn id(&self) -> Option<&str>

Get the document ID (last segment of the path).

pub fn parent_path(&self) -> Option<&str>

Get the parent path (all segments except the last).

pub fn data(&self) -> Option<&Value>

Get the document data if this is a Create or Update event.

pub fn is_create(&self) -> bool

Check if this is a Create event.

pub fn is_update(&self) -> bool

Check if this is an Update event.

pub fn is_delete(&self) -> bool

Check if this is a Delete event.

Trait Implementations

impl Clone for ChangeEvent

fn clone(&self) -> ChangeEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChangeEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChangeEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ChangeEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.