Struct RichText 

pub struct RichText { /* private fields */ }

Collaborative rich text with formatting support.

Combines RGAText for the text content with a set of anchor-based marks for formatting.

Implementations

impl RichText

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

Create a new empty rich text.

pub fn replica_id(&self) -> &str

Get the replica ID.

pub fn text_content(&self) -> String

Get the underlying text as a String.

pub fn len(&self) -> usize

Get the text length.

pub fn is_empty(&self) -> bool

Check if empty.

pub fn text(&self) -> &RGAText

Get access to the underlying RGAText.

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

Insert plain text at a position.

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

Delete text range.

pub fn replace(&mut self, start: usize, end: usize, text: &str)

Replace text range.

pub fn add_mark( &mut self, start: usize, end: usize, mark_type: MarkType, ) -> MarkId

Add a formatting mark to a range.

pub fn bold(&mut self, start: usize, end: usize) -> MarkId

Add bold formatting.

pub fn italic(&mut self, start: usize, end: usize) -> MarkId

Add italic formatting.

pub fn underline(&mut self, start: usize, end: usize) -> MarkId

Add underline formatting.

pub fn link( &mut self, start: usize, end: usize, url: impl Into<String>, ) -> MarkId

Add a link.

pub fn comment( &mut self, start: usize, end: usize, author: impl Into<String>, content: impl Into<String>, ) -> MarkId

Add a comment/annotation.

pub fn highlight( &mut self, start: usize, end: usize, color: impl Into<String>, ) -> MarkId

Add a highlight.

pub fn remove_mark(&mut self, id: &MarkId) -> bool

Remove a mark by ID.

pub fn remove_marks_in_range( &mut self, start: usize, end: usize, mark_type: &MarkType, )

Remove all marks of a type from a range.

pub fn marks_at(&self, position: usize) -> Vec<&Mark>

Get all marks at a position.

pub fn marks_in_range(&self, start: usize, end: usize) -> Vec<&Mark>

Get all marks in a range.

pub fn has_mark(&self, position: usize, mark_type: &MarkType) -> bool

Check if a position has a specific mark type.

pub fn all_marks(&self) -> impl Iterator<Item = &Mark> + '_

Get all marks (including deleted for debugging).

pub fn active_marks(&self) -> impl Iterator<Item = &Mark> + '_

Get only active marks.

pub fn take_delta(&mut self) -> Option<RichTextDelta>

Take the pending delta.

pub fn apply_delta(&mut self, delta: &RichTextDelta)

Apply a delta from another replica.

pub fn to_html(&self) -> String

Render as HTML (basic implementation).

Trait Implementations

impl Clone for RichText

fn clone(&self) -> RichText

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RichText

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RichText

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RichText

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RichText

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Lattice for RichText

fn bottom() -> Self

The bottom element (identity for join)

fn join(&self, other: &Self) -> Self

Join operation (least upper bound) Must be commutative, associative, and idempotent

fn partial_cmp_lattice(&self, other: &Self) -> Option<Ordering>

Partial order derived from join: a ≤ b iff a ⊔ b = b

fn leq(&self, other: &Self) -> bool

Check if self ≤ other in the lattice order

fn join_assign(&mut self, other: &Self)

Join-assign: self = self ⊔ other

impl PartialEq for RichText

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RichText

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RichText