hexedtech/codemp
3
0
Fork 0
mirror of https://github.com/hexedtech/codemp.git synced 2024-10-22 17:59:20 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: include doc into textchange block

Browse source
This commit is contained in:
əlemi 2023-11-17 05:53:38 +01:00
parent 9df4594408
commit 76e61b1abb
1 changed files with 16 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
src/api/change.rs
View file

@ -1,20 +1,23 @@
//! # TextChange
//! this represent a range in the previous state of the string and a new content which should be
//! replaced to it, allowing to represent any combination of deletions, insertions or replacements
//!
//! bulk and widespread operations will result in a TextChange effectively sending the whole new
//! buffer, but small changes are efficient and easy to create or apply
//!
//! ### examples
//! to insert 'a' after 4th character we should send a
//! `TextChange { span: 4..4, content: "a".into() }`
//!
//! to delete a the fourth character we should send a
//! `TextChange { span: 3..4, content: "".into() }`
//!
//! an editor-friendly representation of a text change in a buffer
//! to easily interface with codemp from various editors
/// an editor-friendly representation of a text change in a buffer
/// span refers to previous text content
///
/// this represent a range in the previous state of the string and a new content which should be
/// replaced to it, allowing to represent any combination of deletions, insertions or replacements
///
/// bulk and widespread operations will result in a TextChange effectively sending the whole new
/// buffer, but small changes are efficient and easy to create or apply
///
/// ### examples
/// to insert 'a' after 4th character we should send a
/// `TextChange { span: 4..4, content: "a".into() }`
///
/// to delete a the fourth character we should send a
/// `TextChange { span: 3..4, content: "".into() }`
///
#[derive(Clone, Debug, Default)]
pub struct TextChange {
/// range of text change, as char indexes in buffer previous state