Struct yrs::YArrayEvent

#[repr(C)]
pub struct YArrayEvent {
    pub txn: *const Transaction,
    /* private fields */
}

Event pushed into callbacks registered with yarray_observe function. It contains delta of all content changes made within a scope of corresponding transaction (see: yarray_event_delta) as well as navigation data used to identify a YArray instance which triggered this event.

Fields

txn: *const Transaction

Methods from Deref<Target = ArrayEvent>

pub fn target(&self) -> &Array

Returns an Array instance which emitted this event.

pub fn path(&self) -> VecDeque<PathSegment, Global>

Returns a path from root type down to [Text] instance which emitted this event.

pub fn delta(&self, txn: &Transaction) -> &[Change]

Returns summary of changes made over corresponding Array collection within a bounds of current transaction.

pub fn inserts(&self, txn: &Transaction) -> &HashSet<ID, RandomState>

Returns a collection of block identifiers that have been added within a bounds of current transaction.

pub fn removes(&self, txn: &Transaction) -> &HashSet<ID, RandomState>

Returns a collection of block identifiers that have been removed within a bounds of current transaction.

Trait Implementations

impl Clone for YArrayEvent

fn clone(&self) -> YArrayEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for YArrayEvent

type Target = ArrayEvent

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Copy for YArrayEvent