Struct yrs::YXmlEvent

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

Event pushed into callbacks registered with yxmlelem_observe function. It contains all attribute changes made within a scope of corresponding transaction (see: yxmlelem_event_keys) as well as child XML nodes changes (see: yxmlelem_event_delta) and navigation data used to identify a YXmlElement instance which triggered this event.

Fields

txn: *const Transaction

Methods from Deref<Target = XmlEvent>

pub fn children_changed(&self) -> bool

True if any child XML nodes have been changed within bounds of current transaction.

pub fn target(&self) -> &XmlElement

Returns a XmlElement instance which emitted this event.

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

Returns a path from root type down to XmlElement instance which emitted this event.

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

Returns a summary of XML child nodes changed within corresponding XmlElement collection within bounds of current transaction.

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

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

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

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

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

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

Trait Implementations

impl Clone for YXmlEvent

fn clone(&self) -> YXmlEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for YXmlEvent

type Target = XmlEvent

The resulting type after dereferencing.

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

Dereferences the value.

impl Copy for YXmlEvent