Struct CollaborativeDocument 

pub struct CollaborativeDocument { /* private fields */ }

A collaborative rich text document backed by CRDTs.

This is the main entry point for document editing. All operations are conflict-free and can be merged with remote changes.

Implementations

impl CollaborativeDocument

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

Create a new collaborative document.

Arguments

• doc_id - Unique identifier for this document
• replica_id - Unique identifier for this replica/user

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

Insert text at a position.

Arguments

• position - Character index to insert at (0-based)
• text - Text to insert

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

Delete text at a position.

Arguments

• position - Starting character index (0-based)
• length - Number of characters to delete

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

Apply bold formatting to a range.

Arguments

• start - Starting character index (inclusive)
• end - Ending character index (exclusive)

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

Apply italic formatting to a range.

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

Apply underline formatting to a range.

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

Apply strikethrough formatting to a range.

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

Apply inline code formatting to a range.

pub fn apply_link(&mut self, start: usize, end: usize, url: &str)

Apply a link to a range.

Arguments

• start - Starting character index (inclusive)
• end - Ending character index (exclusive)
• url - The URL to link to

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

Apply a highlight color to a range.

Arguments

• start - Starting character index (inclusive)
• end - Ending character index (exclusive)
• color - CSS color string (e.g., “#FFEAA7”)

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

Apply a comment annotation to a range.

Arguments

• start - Starting character index (inclusive)
• end - Ending character index (exclusive)
• author - Comment author name/id
• content - Comment body

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

Apply a custom formatting mark to a range.

Arguments

• start - Starting character index (inclusive)
• end - Ending character index (exclusive)
• name - Custom mark name
• value - Custom mark value

pub fn get_text(&self) -> String

Get the plain text content (without formatting).

pub fn get_html(&self) -> String

Get the content as HTML with formatting applied.

pub fn len(&self) -> usize

Get the document length in characters.

pub fn is_empty(&self) -> bool

Check if the document is empty.

pub fn version(&self) -> u64

Get the current version number.

This increments with each local operation and can be used to track changes for sync purposes.

pub fn doc_id(&self) -> String

Get the document ID.

pub fn replica_id(&self) -> String

Get the replica ID.

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

Serialize the document state for sync.

Returns a base64-encoded binary string that can be sent to other replicas. Binary format is more efficient and handles complex key types.

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

Merge remote state into this document.

This is the core CRDT operation - merging is commutative, associative, and idempotent, so the order of merges doesn’t matter.

Arguments

• remote_state - JSON string from another replica’s serialize()

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

Create a snapshot of the current state.

This returns a JSON object with full document state.

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

Restore from a snapshot.

Trait Implementations

impl From<CollaborativeDocument> for JsValue

fn from(value: CollaborativeDocument) -> Self

Converts to this type from the input type.

impl FromWasmAbi for CollaborativeDocument

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 CollaborativeDocument

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 CollaborativeDocument

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<CollaborativeDocument>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for CollaborativeDocument

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 CollaborativeDocument

fn none() -> Self::Abi

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

impl RefFromWasmAbi for CollaborativeDocument

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<CollaborativeDocument>

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 CollaborativeDocument

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<CollaborativeDocument>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for CollaborativeDocument

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

Performs the conversion.

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

Performs the conversion.

impl VectorFromWasmAbi for CollaborativeDocument

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

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

impl VectorIntoWasmAbi for CollaborativeDocument

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

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

impl WasmDescribe for CollaborativeDocument

fn describe()

impl WasmDescribeVector for CollaborativeDocument

fn describe_vector()

impl SupportsConstructor for CollaborativeDocument

impl SupportsInstanceProperty for CollaborativeDocument

impl SupportsStaticProperty for CollaborativeDocument