Struct yrs::types::text::Text

#[repr(transparent)]
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) -> 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, txn: &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 insert_with_attributes(
    &self,
    txn: &mut Transaction,
    index: u32,
    chunk: &str,
    attributes: 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 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,
    embed: 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, 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.

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

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

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

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

All text changes can be tracked by using TextEvent::delta method: keep in mind that delta contains collection of individual characters rather than strings.

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.

pub fn diff(&self, txn: &mut Transaction) -> Vec<Diff>

pub fn diff_range(
    &self,
    txn: &mut Transaction,
    hi: Option<&Snapshot>,
    lo: Option<&Snapshot>
) -> Vec<Diff>

Returns the Delta representation of this YText type.

Trait Implementations

impl AsMut<Branch> for Text

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

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

impl AsRef<Branch> for Text

fn as_ref(&self) -> &Branch

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

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<BranchPtr> for Text

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