Skip to main content

RichTextDoc

Struct RichTextDoc 

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

A collaborative rich text document with formatting.

Implementations§

Source§

impl RichTextDoc

Source

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

Create a new rich text document.

Source

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

Insert text at position.

Source

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

Delete text at position.

Source

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

Apply formatting to a range.

Source

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

Remove formatting by mark ID.

Source

pub fn get_text(&self) -> String

Get the plain text content.

Source

pub fn get_content(&self) -> String

Get the plain text as spans with marks. Note: For full mark information, use the underlying RichText directly.

Source

pub fn len(&self) -> usize

Get the text length.

Source

pub fn is_empty(&self) -> bool

Check if the document is empty.

Source

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

Merge another document’s state into this one (CRDT merge). This applies changes from the other document while preserving local changes.

Source

pub fn clone_state(&self) -> RichTextDoc

Clone this document’s state for syncing to another replica.

Trait Implementations§

Source§

impl Clone for RichTextDoc

Source§

fn clone(&self) -> RichTextDoc

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl CollaborativeDoc for RichTextDoc

Source§

fn id(&self) -> &str

Get the document ID.
Source§

fn replica_id(&self) -> &str

Get the replica ID.
Source§

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

Subscribe to document events.
Source§

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

Take pending deltas for sync.
Source§

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

Apply a remote delta.

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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