Skip to main content

RichTextDocument

Struct RichTextDocument 

Source
pub struct RichTextDocument { /* private fields */ }
Expand description

Explicit rich text wrapper for SDK-style API naming.

This wraps CollaborativeDocument and exposes the same rich-text CRDT behavior.

Implementations§

Source§

impl RichTextDocument

Source

pub fn new(doc_id: &str, replica_id: &str) -> Self

Source

pub fn insert(&mut self, position: usize, text: &str)

Source

pub fn delete(&mut self, position: usize, length: usize)

Source

pub fn apply_bold(&mut self, start: usize, end: usize)

Source

pub fn apply_italic(&mut self, start: usize, end: usize)

Source

pub fn apply_underline(&mut self, start: usize, end: usize)

Source

pub fn apply_strikethrough(&mut self, start: usize, end: usize)

Source

pub fn apply_code(&mut self, start: usize, end: usize)

Source

pub fn apply_highlight(&mut self, start: usize, end: usize, color: &str)

Source

pub fn apply_comment( &mut self, start: usize, end: usize, author: &str, content: &str, )

Source

pub fn apply_custom_mark( &mut self, start: usize, end: usize, name: &str, value: &str, )

Source

pub fn get_text(&self) -> String

Source

pub fn get_html(&self) -> String

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn version(&self) -> u64

Source

pub fn doc_id(&self) -> String

Source

pub fn replica_id(&self) -> String

Source

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

Source

pub fn merge(&mut self, remote_state: &str) -> Result<(), JsValue>

Source

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

Source

pub fn restore(snapshot_js: JsValue) -> Result<RichTextDocument, JsValue>

Trait Implementations§

Source§

impl From<RichTextDocument> for JsValue

Source§

fn from(value: RichTextDocument) -> Self

Converts to this type from the input type.
Source§

impl FromWasmAbi for RichTextDocument

Source§

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.
Source§

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi. Read more
Source§

impl IntoWasmAbi for RichTextDocument

Source§

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.
Source§

fn into_abi(self) -> u32

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

impl LongRefFromWasmAbi for RichTextDocument

Source§

type Abi = u32

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRef<RichTextDocument>

Same as RefFromWasmAbi::Anchor
Source§

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

Same as RefFromWasmAbi::ref_from_abi
Source§

impl OptionFromWasmAbi for RichTextDocument

Source§

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.
Source§

impl OptionIntoWasmAbi for RichTextDocument

Source§

fn none() -> Self::Abi

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

impl RefFromWasmAbi for RichTextDocument

Source§

type Abi = u32

The Wasm ABI type references to Self are recovered from.
Source§

type Anchor = RcRef<RichTextDocument>

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.
Source§

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

Recover a Self::Anchor from Self::Abi. Read more
Source§

impl RefMutFromWasmAbi for RichTextDocument

Source§

type Abi = u32

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRefMut<RichTextDocument>

Same as RefFromWasmAbi::Anchor
Source§

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

Same as RefFromWasmAbi::ref_from_abi
Source§

impl TryFromJsValue for RichTextDocument

Source§

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

Performs the conversion.
Source§

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.
Source§

impl VectorFromWasmAbi for RichTextDocument

Source§

impl VectorIntoWasmAbi for RichTextDocument

Source§

impl WasmDescribe for RichTextDocument

Source§

impl WasmDescribeVector for RichTextDocument

Source§

impl SupportsConstructor for RichTextDocument

Source§

impl SupportsInstanceProperty for RichTextDocument

Source§

impl SupportsStaticProperty for RichTextDocument

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ReturnWasmAbi for T
where T: IntoWasmAbi,

Source§

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi
Source§

fn return_abi(self) -> <T as ReturnWasmAbi>::Abi

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V