Struct yrs::types::text::Text

pub struct Text(_);

A shared data type used for collaborative text editing. 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.

Text 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, Text 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 Text

pub fn to_string(&self, txn: &Transaction<'_>) -> String

Converts context of this text data structure into a single string value.

pub fn len(&self) -> u32

Returns a number of characters visible in a current text data structure.

pub fn insert(&self, tr: &mut Transaction<'_>, index: u32, chunk: &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 push(&self, txn: &mut Transaction<'_>, chunk: &str)

Appends a given chunk of text at the end of a current text structure.

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

Removes up to a len characters from a current text structure, starting at given index. This method panics in case when not all expected characters were removed (due to insufficient number of characters to remove) or index is outside of the bounds of text.

Trait Implementations

impl Clone for Text

fn clone(&self) -> Text

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl From<BranchRef> for Text

fn from(inner: BranchRef) -> Self

Performs the conversion.

impl Into<ItemContent> for Text

fn into(self) -> ItemContent

Performs the conversion.

impl Into<XmlText> for Text

fn into(self) -> XmlText

Performs the conversion.

impl PartialEq<Text> for Text

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

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

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

This method tests for !=.

impl Eq for Text

impl StructuralEq for Text

impl StructuralPartialEq for Text