Struct yrs::types::xml::XmlText

#[repr(transparent)]
pub struct XmlText(_);

A shared data type used for collaborative text editing, that can be used in a context of XmlElement nodee. It enables multiple users to add and remove chunks of text in efficient manner. This type is internally represented as a mutable double-linked list of text chunks

• an optimization occurs during Transaction::commit, which allows to squash multiple consecutively inserted characters together as a single chunk of text even between transaction boundaries in order to preserve more efficient memory model.

Just like XmlElement, XmlText can be marked with extra metadata in form of attributes.

XmlText structure internally uses UTF-8 encoding and its length is described in a number of bytes rather than individual characters (a single UTF-8 code point can consist of many bytes).

Like all Yrs shared data types, XmlText is resistant to the problem of interleaving (situation when characters inserted one after another may interleave with other peers concurrent inserts after merging all updates together). In case of Yrs conflict resolution is solved by using unique document id to determine correct and consistent ordering.

Implementations

impl XmlText

pub fn to_string(&self) -> String

Returns a string representation of a current XML text.

pub fn remove_attribute(&self, txn: &mut Transaction, attr_name: &str)

pub fn insert_attribute<K: Into<Rc<str>>, V: AsRef<str>>(
    &self,
    txn: &mut Transaction,
    attr_name: K,
    attr_value: V
)

pub fn get_attribute(&self, attr_name: &str) -> Option<String>

pub fn attributes(&self) -> Attributes<'_>

pub fn next_sibling(&self) -> Option<Xml>

Returns next XML sibling of this XML text, which can be either a XmlElement, XmlText or None if current text is a last child of its parent XML element.

pub fn prev_sibling(&self) -> Option<Xml>

Returns previous XML sibling of this XML text, which can be either a XmlElement, XmlText or None if current text is a first child of its parent XML element.

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

Returns a parent XML element containing this XML text value.

pub fn len(&self) -> u32

Returns a number of characters contained under this XML text structure.

pub fn insert(&self, txn: &mut Transaction, index: u32, content: &str)

Inserts a chunk of text at a given index. If index is 0, this chunk will be inserted at the beginning of a current text. If index is equal to current data structure length, this chunk will be appended at the end of it.

This method will panic if provided index is greater than the length of a current text.

pub fn insert_with_attributes(
    &self,
    txn: &mut Transaction,
    index: u32,
    content: &str,
    attrs: Attrs
)

Inserts a chunk of text at a given index. If index is 0, this chunk will be inserted at the beginning of a current text. If index is equal to current data structure length, this chunk will be appended at the end of it. Collection of supplied attributes will be used to wrap provided text chunk range with a formatting blocks.

This method will panic if provided index is greater than the length of a current text.

pub fn format(&self, txn: &mut Transaction, index: u32, len: u32, attrs: Attrs)

Wraps an existing piece of text within a range described by index-len parameters with formatting blocks containing provided attributes metadata.

pub fn insert_embed(&self, txn: &mut Transaction, index: u32, content: Any)

Inserts an embed content at a given index.

If index is 0, this content will be inserted at the beginning of a current text. If index is equal to current data structure length, this embed will be appended at the end of it.

This method will panic if provided index is greater than the length of a current text.

pub fn insert_embed_with_attributes(
    &self,
    txn: &mut Transaction,
    index: u32,
    content: Any,
    attributes: Attrs
)

Inserts an embed content of text at a given index. If index is 0, this content will be inserted at the beginning of a current text. If index is equal to current data structure length, this chunk will be appended at the end of it. Collection of supplied attributes will be used to wrap provided text content range with a formatting blocks.

This method will panic if provided index is greater than the length of a current text.

pub fn push(&self, txn: &mut Transaction, content: &str)

Appends a new string content at the end of this XML text structure.

pub fn remove_range(&self, txn: &mut Transaction, index: u32, len: u32)

Removes a number of characters specified by a len parameter from this XML text structure, starting at given index. This method may panic if index if greater than a length of this text.

pub fn observe<F>(&mut self, f: F) -> Subscription<XmlTextEvent> where
    F: Fn(&Transaction, &XmlTextEvent) + 'static, 

Subscribes a given callback to be triggered whenever current XML text 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.

XML text changes can be tracked by using [Event::delta] method: keep in mind that delta contains collection of individual characters rather than strings. XML text attribute changes can be tracked using [Event::keys] method.

Returns an [Observer] which, when dropped, will unsubscribe current callback.

pub fn unobserve(&mut self, subscription_id: SubscriptionId)

Unsubscribes a previously subscribed event callback identified by given subscription_id.

Trait Implementations

impl AsMut<Branch> for XmlText

fn as_mut(&mut self) -> &mut Branch

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

impl AsRef<Branch> for XmlText

fn as_ref(&self) -> &Branch

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

impl Clone for XmlText

fn clone(&self) -> XmlText

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for XmlText

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

Formats the value using the given formatter.

impl From<BranchPtr> for XmlText

fn from(inner: BranchPtr) -> Self

Converts to this type from the input type.

impl Into<XmlText> for Text

fn into(self) -> XmlText

Converts this type into the (usually inferred) input type.

impl PartialEq<XmlText> for XmlText

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl TryInto<XmlText> for Xml

type Error = XmlElement

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for XmlText

impl StructuralEq for XmlText

impl StructuralPartialEq for XmlText