Skip to main content

TextRef

Struct TextRef 

Source
pub struct TextRef<'a> { /* private fields */ }
Expand description

Read-only reference to a Text CRDT.

Text is a sequence CRDT optimized for collaborative text editing. For large documents, prefer slice() or chars() over content() to avoid allocating the entire string.

Implementations§

Source§

impl<'a> TextRef<'a>

Source

pub fn id(&self) -> CrdtId

Get the CRDT ID for this text.

Source

pub fn content(&self) -> String

Get the full text content as a String.

For large documents, consider using slice() or chars() instead to avoid allocating the entire string.

Source

pub fn slice(&self, range: Range<usize>) -> String

Get a slice of the text as a String.

Range is in Unicode characters (not bytes). This is more efficient than content() for extracting portions of large documents.

§Example
use diamond_types_extended::{Document, Uuid};

let mut doc = Document::new();
let alice = doc.create_agent(Uuid::from_u128(0xA11CE));

doc.transact(alice, |tx| {
    let id = tx.root().create_text("content");
    tx.text_by_id(id).unwrap().insert(0, "Hello, world!");
});

let text = doc.root().get_text("content").unwrap();
assert_eq!(text.slice(0..5), "Hello");
assert_eq!(text.slice(7..12), "world");
Source

pub fn chars(&self) -> impl Iterator<Item = char>

Iterate over characters in the text.

More memory-efficient than content() for large documents when you only need to iterate.

Source

pub fn len(&self) -> usize

Get the length in Unicode characters.

Source

pub fn is_empty(&self) -> bool

Check if the text is empty.

Auto Trait Implementations§

§

impl<'a> Freeze for TextRef<'a>

§

impl<'a> RefUnwindSafe for TextRef<'a>

§

impl<'a> Send for TextRef<'a>

§

impl<'a> Sync for TextRef<'a>

§

impl<'a> Unpin for TextRef<'a>

§

impl<'a> UnsafeUnpin for TextRef<'a>

§

impl<'a> UnwindSafe for TextRef<'a>

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> 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, 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