Struct TextHandler

pub struct TextHandler { /* private fields */ }

Flatten attributes that allow overlap

Implementations

impl TextHandler

pub fn new_detached() -> Self

Create a new container that is detached from the document.

The edits on a detached container will not be persisted. To attach the container to the document, please insert it into an attached container.

pub fn version_id(&self) -> usize

Get the version id of the richtext

This can be used to detect whether the richtext is changed

pub fn get_richtext_value(&self) -> LoroValue

pub fn is_empty(&self) -> bool

pub fn len_utf8(&self) -> usize

pub fn len_utf16(&self) -> usize

pub fn len_unicode(&self) -> usize

pub fn len_event(&self) -> usize

if wasm feature is enabled, it is a UTF-16 length otherwise, it is a Unicode length

pub fn diagnose(&self)

pub fn iter(&self, callback: impl FnMut(&str) -> bool)

pub fn char_at(&self, pos: usize) -> LoroResult<char>

pos is a Event Index:

• if feature=“wasm”, pos is a UTF-16 index
• if feature!=“wasm”, pos is a Unicode index

pub fn slice(&self, start_index: usize, end_index: usize) -> LoroResult<String>

start_index and end_index are Event Index:

• if feature=“wasm”, pos is a UTF-16 index
• if feature!=“wasm”, pos is a Unicode index

pub fn splice(&self, pos: usize, len: usize, s: &str) -> LoroResult<String>

pos is a Event Index:

• if feature=“wasm”, pos is a UTF-16 index
• if feature!=“wasm”, pos is a Unicode index

This method requires auto_commit to be enabled.

pub fn splice_utf8(&self, pos: usize, len: usize, s: &str) -> LoroResult<()>

pub fn insert(&self, pos: usize, s: &str) -> LoroResult<()>

pos is a Event Index:

• if feature=“wasm”, pos is a UTF-16 index
• if feature!=“wasm”, pos is a Unicode index

This method requires auto_commit to be enabled.

pub fn insert_utf8(&self, pos: usize, s: &str) -> LoroResult<()>

pub fn insert_unicode(&self, pos: usize, s: &str) -> LoroResult<()>

pub fn insert_with_txn( &self, txn: &mut Transaction, pos: usize, s: &str, ) -> LoroResult<()>

pos is a Event Index:

• if feature=“wasm”, pos is a UTF-16 index
• if feature!=“wasm”, pos is a Unicode index

pub fn insert_with_txn_utf8( &self, txn: &mut Transaction, pos: usize, s: &str, ) -> LoroResult<()>

pub fn delete(&self, pos: usize, len: usize) -> LoroResult<()>

pos is a Event Index:

• if feature=“wasm”, pos is a UTF-16 index
• if feature!=“wasm”, pos is a Unicode index

This method requires auto_commit to be enabled.

pub fn delete_utf8(&self, pos: usize, len: usize) -> LoroResult<()>

pub fn delete_unicode(&self, pos: usize, len: usize) -> LoroResult<()>

pub fn delete_with_txn( &self, txn: &mut Transaction, pos: usize, len: usize, ) -> LoroResult<()>

pos is a Event Index:

• if feature=“wasm”, pos is a UTF-16 index
• if feature!=“wasm”, pos is a Unicode index

pub fn mark( &self, start: usize, end: usize, key: impl Into<InternalString>, value: LoroValue, ) -> LoroResult<()>

start and end are [Event Index]s:

• if feature=“wasm”, pos is a UTF-16 index
• if feature!=“wasm”, pos is a Unicode index

This method requires auto_commit to be enabled.

pub fn unmark( &self, start: usize, end: usize, key: impl Into<InternalString>, ) -> LoroResult<()>

start and end are [Event Index]s:

• if feature=“wasm”, pos is a UTF-16 index
• if feature!=“wasm”, pos is a Unicode index

This method requires auto_commit to be enabled.

pub fn mark_with_txn( &self, txn: &mut Transaction, start: usize, end: usize, key: impl Into<InternalString>, value: LoroValue, is_delete: bool, ) -> LoroResult<()>

start and end are [Event Index]s:

• if feature=“wasm”, pos is a UTF-16 index
• if feature!=“wasm”, pos is a Unicode index

pub fn check(&self)

pub fn apply_delta(&self, delta: &[TextDelta]) -> LoroResult<()>

pub fn apply_delta_with_txn( &self, txn: &mut Transaction, delta: &[TextDelta], ) -> LoroResult<()>

pub fn update( &self, text: &str, options: UpdateOptions, ) -> Result<(), UpdateTimeoutError>

pub fn update_by_line( &self, text: &str, options: UpdateOptions, ) -> Result<(), UpdateTimeoutError>

pub fn to_string(&self) -> String

pub fn get_cursor(&self, event_index: usize, side: Side) -> Option<Cursor>

pub fn is_deleted(&self) -> bool

pub fn push_str(&self, s: &str) -> LoroResult<()>

Trait Implementations

impl Clone for TextHandler

fn clone(&self) -> TextHandler

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextHandler

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

Formats the value using the given formatter.

impl HandlerTrait for TextHandler

fn to_handler(&self) -> Handler

fn attach( &self, txn: &mut Transaction, parent: &BasicHandler, self_id: ContainerID, ) -> LoroResult<Self>

This method returns an attached handler.

fn attached_handler(&self) -> Option<&BasicHandler>

fn get_value(&self) -> LoroValue

fn get_deep_value(&self) -> LoroValue

fn is_attached(&self) -> bool

fn kind(&self) -> ContainerType

fn get_attached(&self) -> Option<Self>

If a detached container is attached, this method will return its corresponding attached handler.

fn from_handler(h: Handler) -> Option<Self>

fn doc(&self) -> Option<LoroDoc>

fn parent(&self) -> Option<Handler>

fn idx(&self) -> ContainerIdx

fn id(&self) -> ContainerID

fn with_state<R>( &self, f: impl FnOnce(&mut State) -> LoroResult<R>, ) -> LoroResult<R>