Struct ywasm::Text

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

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 get_type(&self) -> u8

pub fn id(&self) -> Result<JsValue, JsValue>

Gets unique logical identifier of this type, shared across peers collaborating on the same document.

pub fn prelim(&self) -> bool

Returns true if this is a preliminary instance of YArray.

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 alive(&self, txn: &YTransaction) -> bool

Checks if current YArray reference is alive and has not been deleted by its parent collection. This method only works on already integrated shared types and will return false is current type is preliminary (has not been integrated into document).

pub fn length(&self, txn: &ImplicitTransaction) -> Result<u32, JsValue>

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: &ImplicitTransaction) -> Result<String, JsValue>

Returns an underlying shared string stored in this data type.

pub fn to_json(&self, txn: &ImplicitTransaction) -> Result<JsValue, JsValue>

Returns an underlying shared string stored in this data type.

pub fn insert( &mut self, index: u32, chunk: &str, attributes: JsValue, txn: ImplicitTransaction ) -> Result<(), JsValue>

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

Optional object with defined attributes will be used to wrap provided text chunk with a formatting blocks.attributes are only supported for a YText instance which already has been integrated into document store.

pub fn insert_embed( &self, index: u32, embed: JsValue, attributes: JsValue, txn: ImplicitTransaction ) -> Result<(), JsValue>

Inserts a given embed object into this YText instance, starting at a given index.

Optional object with defined attributes will be used to wrap provided embed with a formatting blocks.attributes are only supported for a YText instance which already has been integrated into document store.

pub fn format( &self, index: u32, length: u32, attributes: JsValue, txn: ImplicitTransaction ) -> Result<(), JsValue>

Wraps an existing piece of text within a range described by index-length parameters with formatting blocks containing provided attributes metadata. This method only works for YText instances that already have been integrated into document store.

pub fn push( &mut self, chunk: &str, attributes: JsValue, txn: ImplicitTransaction ) -> Result<(), JsValue>

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

Optional object with defined attributes will be used to wrap provided text chunk with a formatting blocks.attributes are only supported for a YText instance which already has been integrated into document store.

pub fn delete( &mut self, index: u32, length: u32, txn: ImplicitTransaction ) -> Result<(), JsValue>

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.

pub fn quote( &self, lower: u32, upper: u32, lower_open: Option<bool>, upper_open: Option<bool>, txn: &ImplicitTransaction ) -> Result<YWeakLink, JsValue>

pub fn to_delta( &self, snapshot: Option<YSnapshot>, prev_snapshot: Option<YSnapshot>, compute_ychange: Option<Function>, txn: ImplicitTransaction ) -> Result<Array, JsValue>

Returns the Delta representation of this YText type.

pub fn observe(&self, f: Function) -> Result<Observer, JsValue>

Subscribes to all operations happening over this instance of YText. All changes are batched and eventually triggered during transaction commit phase. Returns an YTextObserver which, when free’d, will unsubscribe current callback.

pub fn observe_deep(&self, f: Function) -> Result<Observer, JsValue>

Subscribes to all operations happening over this Y shared type, as well as events in shared types stored within this one. All changes are batched and eventually triggered during transaction commit phase. Returns an YEventObserver which, when free’d, will unsubscribe current callback.

Trait Implementations

impl From<YText> for JsValue

fn from(value: YText) -> Self

Converts to this type from the input type.

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 LongRefFromWasmAbi for YText

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = Ref<'static, YText>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

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 TryFromJsValue for YText

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for YText

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[YText]>

impl VectorIntoWasmAbi for YText

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[YText]>) -> Self::Abi

impl WasmDescribe for YText

fn describe()

impl WasmDescribeVector for YText

fn describe_vector()