Struct yrs::YXmlEvent

source ·
#[repr(C)]
pub struct YXmlEvent { /* private fields */ }
Expand description

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.

Methods from Deref<Target = XmlEvent>§

source

pub fn children_changed(&self) -> bool

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

source

pub fn target(&self) -> &XmlNode

Returns a [XmlElement] instance which emitted this event.

source

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

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

source

pub fn delta(&self, txn: &TransactionMut<'_>) -> &[Change]

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

source

pub fn added(&self, txn: &TransactionMut<'_>) -> &HashSet<ID>

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

source

pub fn deleted(&self, txn: &TransactionMut<'_>) -> &HashSet<ID>

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

source

pub fn keys(&self, txn: &TransactionMut<'_>) -> &HashMap<Arc<str>, EntryChange>

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

Trait Implementations§

source§

impl Clone for YXmlEvent

source§

fn clone(&self) -> YXmlEvent

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Deref for YXmlEvent

§

type Target = XmlEvent

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl Copy for YXmlEvent

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.