Struct XmlFragmentRef

pub struct XmlFragmentRef(/* private fields */);

A XML fragment, which works as an untagged collection of XML nodes.

Implementations

impl XmlFragmentRef

pub fn parent(&self) -> Option<XmlOut>

Trait Implementations

impl AsPrelim for XmlFragmentRef

type Prelim = XmlFragmentPrelim

fn as_prelim<T: ReadTxn>(&self, txn: &T) -> Self::Prelim

Converts current type contents into a Prelim type that can be used to create a new type that’s a deep copy equivalent of a current type.

impl AsRef<ArrayRef> for XmlFragmentRef

fn as_ref(&self) -> &ArrayRef

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Branch> for XmlFragmentRef

fn as_ref(&self) -> &Branch

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<XmlFragmentRef> for XmlElementRef

fn as_ref(&self) -> &XmlFragmentRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for XmlFragmentRef

fn clone(&self) -> XmlFragmentRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XmlFragmentRef

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

Formats the value using the given formatter.

impl DeepObservable for XmlFragmentRef

fn observe_deep<F>(&self, f: F) -> Subscription

where F: Fn(&TransactionMut<'_>, &Events<'_>) + 'static,

Subscribe a callback f for all events emitted by this and nested collaborative types. Callback is accepting transaction which triggered that event and event itself, wrapped within an Event structure.

fn observe_deep_with<K, F>(&self, key: K, f: F)

where K: Into<Origin>, F: Fn(&TransactionMut<'_>, &Events<'_>) + 'static,

Subscribe a callback f for all events emitted by this and nested collaborative types. Callback is accepting transaction which triggered that event and event itself, wrapped within an Event structure.

fn unobserve_deep<K: Into<Origin>>(&self, key: K) -> bool

Unsubscribe a callback identified by a given key, that was previously subscribed using Self::observe_deep_with.

impl DefaultPrelim for XmlFragmentRef

type Prelim = XmlFragmentPrelim

fn default_prelim() -> Self::Prelim

Returns an instance of Prelim-compatible type, which will turn into reference of a current type after being integrated into the document store.

impl From<BranchPtr> for XmlFragmentRef

fn from(inner: BranchPtr) -> Self

Converts to this type from the input type.

impl GetString for XmlFragmentRef

fn get_string<T: ReadTxn>(&self, txn: &T) -> String

Converts current XML node into a textual representation. This representation if flat, it doesn’t include any indentation.

impl IndexedSequence for XmlFragmentRef

fn sticky_index( &self, txn: &mut TransactionMut<'_>, index: u32, assoc: Assoc, ) -> Option<StickyIndex>

Returns a StickyIndex equivalent to a human-readable index. Returns None if index is beyond the length of current sequence.

impl Observable for XmlFragmentRef

type Event = XmlEvent

fn observe<F>(&self, f: F) -> Subscription

where F: Fn(&TransactionMut<'_>, &Self::Event) + 'static, Event: AsRef<Self::Event>,

Subscribes a given callback to be triggered whenever current y-type is changed. A callback is triggered whenever a transaction gets committed. This function does not trigger if changes have been observed by nested shared collections.

fn observe_with<K, F>(&self, key: K, f: F)

where K: Into<Origin>, F: Fn(&TransactionMut<'_>, &Self::Event) + 'static, Event: AsRef<Self::Event>,

Subscribes a given callback to be triggered whenever current y-type is changed. A callback is triggered whenever a transaction gets committed. This function does not trigger if changes have been observed by nested shared collections.

fn unobserve<K: Into<Origin>>(&self, key: K) -> bool

Unsubscribes a given callback identified by key, that was previously subscribed using Self::observe_with.

impl PartialEq for XmlFragmentRef

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RootRef for XmlFragmentRef

fn type_ref() -> TypeRef

fn root<N: Into<Arc<str>>>(name: N) -> Root<Self>

Create a logical collaborative collection reference to a root-level type with a given name

impl SharedRef for XmlFragmentRef

fn hook(&self) -> Hook<Self>

Returns a logical descriptor of a current shared collection.

impl TryFrom<ItemPtr> for XmlFragmentRef

type Error = ItemPtr

The type returned in the event of a conversion error.

fn try_from(value: ItemPtr) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for XmlFragmentRef

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryInto<XmlFragmentRef> for XmlOut

type Error = XmlOut

The type returned in the event of a conversion error.

fn try_into(self) -> Result<XmlFragmentRef, Self::Error>

Performs the conversion.

impl XmlFragment for XmlFragmentRef

fn first_child(&self) -> Option<XmlOut>

fn children<'a, T: ReadTxn>(&self, txn: &'a T) -> XmlNodes<'a, T>

Returns an iterator over all children of a current XML fragment. It does NOT include nested children of its children - for such cases use Self::successors iterator.

fn len<T: ReadTxn>(&self, _txn: &T) -> u32

Returns a number of elements stored in current array.

fn insert<V>( &self, txn: &mut TransactionMut<'_>, index: u32, xml_node: V, ) -> V::Return

where V: XmlPrelim,

Inserts a value at the given index. Inserting at index 0 is equivalent to prepending current array with given value, while inserting at array length is equivalent to appending that value at the end of it.

fn push_back<V>(&self, txn: &mut TransactionMut<'_>, xml_node: V) -> V::Return

where V: XmlPrelim,

Inserts given value at the end of the current array.

fn push_front<V>(&self, txn: &mut TransactionMut<'_>, xml_node: V) -> V::Return

where V: XmlPrelim,

Inserts given value at the beginning of the current array.

fn remove(&self, txn: &mut TransactionMut<'_>, index: u32)

Removes a single element at provided index.

fn remove_range(&self, txn: &mut TransactionMut<'_>, index: u32, len: u32)

Removes a range of elements from current array, starting at given index up until a particular number described by len has been deleted. This method panics in case when not all expected elements were removed (due to insufficient number of elements in an array) or index is outside the bounds of an array.

fn get<T: ReadTxn>(&self, _txn: &T, index: u32) -> Option<XmlOut>

Retrieves a value stored at a given index. Returns None when provided index was out of the range of a current array.

fn successors<'a, T: ReadTxn>(&'a self, txn: &'a T) -> TreeWalker<'a, &'a T, T>

Returns an iterator that can be used to traverse over the successors of a current XML element. This includes recursive step over children of its children. The recursive iteration is depth-first.

impl Eq for XmlFragmentRef