Struct yrs::types::Event

pub struct Event { /* fields omitted */ }

An event type, triggered upon transaction commit and passed over to function callbacks registered using observe method on corresponding shared data types.

Implementations

impl Event

pub fn target(&self) -> Value

Returns enum containing a reference to a shared data type on which current event has been fired.

pub fn path(&self, txn: &Transaction) -> Path

Returns a path From root level type down to a current shared data type being a Self::target.

pub fn keys(&self, txn: &Transaction) -> &HashMap<Rc<str>, EntryChange>

Returns all changes done upon map component of a current shared data type (which can be accessed using Self::target) within a bounds of corresponding transaction txn. These changes are done in result of operations made on Map data type or attribute changes of XmlElement and XmlText types.

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

Returns identifiers of all new blocks inserted within a bounds of current transaction txn.

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

Returns identifiers of all new blocks tombstoned within a bounds of current transaction txn.

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

Returns collection of all changes done over an array component of a current shared data type (which can be accessed using Self::target). These changes are usually done in result of operations done on Array and Text/XmlText types, but also whenever XmlElement children nodes list is modified.

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.