Struct ywasm::YText

pub struct YText(_);

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

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

pub fn new(init: Option<String>) -> Self

Creates a new preliminary instance of a YText shared data type, with its state initialized to provided parameter.

Preliminary instances can be nested into other shared data types such as YArray and YMap. Once a preliminary instance has been inserted this way, it becomes integrated into ywasm document store and cannot be nested again: attempt to do so will result in an exception.

pub fn prelim(&self) -> bool

Returns true if this is a preliminary instance of YText.

Preliminary instances can be nested into other shared data types such as YArray and YMap. Once a preliminary instance has been inserted this way, it becomes integrated into ywasm document store and cannot be nested again: attempt to do so will result in an exception.

pub fn length(&self) -> u32

Returns length of an underlying string stored in this YText instance, understood as a number of UTF-8 encoded bytes.

pub fn to_string(&self, txn: &YTransaction) -> String

Returns an underlying shared string stored in this data type.

pub fn to_json(&self, txn: &YTransaction) -> JsValue

Returns an underlying shared string stored in this data type.

pub fn insert(&self, txn: &mut YTransaction, index: u32, chunk: &str)

Inserts a given chunk of text into this YText instance, starting at a given index.

pub fn push(&self, txn: &mut YTransaction, chunk: &str)

Appends a given chunk of text at the end of current YText instance.

pub fn delete(&mut self, txn: &mut YTransaction, index: u32, length: u32)

Deletes a specified range of of characters, starting at a given index. Both index and length are counted in terms of a number of UTF-8 character bytes.

Trait Implementations

impl From<Text> for YText

fn from(v: Text) -> Self

Performs the conversion.

impl From<YText> for JsValue

fn from(value: YText) -> Self

Performs the conversion.

impl FromWasmAbi for YText

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for YText

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl OptionFromWasmAbi for YText

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for YText

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for YText

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, YText>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for YText

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, YText>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl WasmDescribe for YText

fn describe()