Struct TextChange

pub struct TextChange {
    pub start_idx: u32,
    pub end_idx: u32,
    pub content: String,
}

An editor-friendly representation of a text change in a given buffer.

It’s expressed with a range of characters and a string of content that should replace them, allowing representation of any combination of deletions, insertions or replacements.

Bulky and large operations will result in a single TextChange effectively sending the whole new buffer, but smaller changes are efficient and easy to create or apply.

Examples

To insert ‘a’ after 4th character we should send:

codemp::api::TextChange { start_idx: 4, end_idx: 4, content: "a".into() };

To delete the fourth character we should send:

codemp::api::TextChange { start_idx: 3, end_idx: 4, content: "".into() };

let change = codemp::api::TextChange {
  start_idx: 6,
  end_idx: 11,
  content: "mom".to_string()
};
let before = "hello world!";
let after = change.apply(before);
assert_eq!(after, "hello mom!");

Fields

start_idx: u32

Range start of text change, as char indexes in buffer previous state.

end_idx: u32

Range end of text change, as char indexes in buffer previous state.

content: String

New content of text inside span.

Implementations

impl TextChange

pub fn span(&self) -> Range<usize>

Returns the std::ops::Range representing this change’s span.

impl TextChange

pub fn is_delete(&self) -> bool

Returns true if this TextChange deletes existing text.

Note that this is is not mutually exclusive with TextChange::is_insert.

pub fn is_insert(&self) -> bool

Returns true if this TextChange adds new text.

Note that this is is not mutually exclusive with TextChange::is_delete.

pub fn is_empty(&self) -> bool

Returns true if this TextChange is effectively as no-op.

pub fn apply(&self, txt: &str) -> String

Applies this text change to given text, returning a new string.

Trait Implementations

impl AsyncSender<TextChange> for BufferController

fn send(&self, op: TextChange) -> ControllerResult<()>

Enqueue a new value to be sent to all other users without blocking

impl Clone for TextChange

fn clone(&self) -> TextChange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextChange

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

Formats the value using the given formatter.

impl Default for TextChange

fn default() -> TextChange

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TextChange

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TextChange

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Controller<TextChange, BufferUpdate> for BufferController