Struct RichTextDoc 

pub struct RichTextDoc { /* private fields */ }

A collaborative rich text document with formatting.

Implementations

impl RichTextDoc

pub fn new(id: impl Into<String>, replica_id: impl Into<String>) -> Self

Create a new rich-text CRDT document.

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

Insert UTF-8 text at a character position.

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

Delete length characters starting at position.

pub fn format(&mut self, start: usize, end: usize, mark: MarkType)

Apply a formatting mark to the range [start, end).

pub fn unformat_by_id(&mut self, mark_id: &MarkId)

Remove a formatting mark by its unique mark ID.

pub fn get_text(&self) -> String

Return the plain-text projection of the rich document.

pub fn get_content(&self) -> String

Return a plain-text rendering of the content.

For full mark spans and metadata, use the underlying RichText model.

pub fn len(&self) -> usize

Return the current text length.

pub fn is_empty(&self) -> bool

Return true when the document contains no characters.

pub fn merge(&mut self, other: &RichTextDoc)

Merge another replica state into this document.

This is a commutative CRDT join, so order does not affect convergence.

pub fn clone_state(&self) -> RichTextDoc

Clone this document’s state for synchronization.

The returned state clears local pending delta buffers.

Trait Implementations

impl Clone for RichTextDoc

fn clone(&self) -> RichTextDoc

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CollaborativeDoc for RichTextDoc

fn id(&self) -> &str

Return the stable document identifier.

fn replica_id(&self) -> &str

Return the local replica identifier that owns this document handle.

fn subscribe(&self) -> Receiver<DocEvent>

Subscribe to document change events.

fn take_pending_deltas(&mut self) -> Vec<Vec<u8>>

Drain pending deltas to send through your sync transport.

fn apply_remote(&mut self, _delta: &[u8])

Apply a serialized remote delta payload.