Struct EditBuffer 

pub struct EditBuffer { /* private fields */ }

Shared Pi-style flat text editing model used by the widget and chat editors.

Implementations

impl EditBuffer

pub fn new(text: &str) -> Self

Creates a buffer with the cursor at the end of sanitized text.

pub const fn set_xml(&mut self, xml: bool)

Enables </ close-tag completion (on by default).

pub fn text(&self) -> &str

Returns the visible marker text.

pub const fn cursor(&self) -> usize

Returns the UTF-8 byte cursor.

pub fn line_count(&self) -> usize

Returns the number of logical newline-delimited lines.

pub fn cursor_line(&self) -> usize

Returns the zero-based logical cursor line.

pub fn cursor_column(&self) -> u16

Returns the cursor’s cell column within its logical line.

pub fn logical_lines( &self, ) -> impl DoubleEndedIterator<Item = &str> + Clone + FusedIterator + '_

Iterates logical lines without allocating.

pub fn replace_external(&mut self, text: &str, cursor_at_start: bool)

Replaces text without creating an undo entry, for history browsing.

pub fn set_cursor_line_column(&mut self, line: usize, column: u16)

Places the cursor on a logical line and cell column.

pub fn set_cursor_visual_row( &mut self, row: usize, column: u16, width_limit: u16, )

Places the cursor on a visual row and cell column.

pub fn replace_range(&mut self, range: Range<usize>, replacement: &str)

Replaces a byte range as one undoable edit. A non-empty range that touches an atomic marker widens to the whole marker, so partial replacements can never tear a unit apart.

pub fn insert_text(&mut self, text: &str) -> BufferOutcome

Inserts sanitized text at the cursor.

Text is inserted verbatim; hosts that collapse large pastes into compact chips stage them through EditBuffer::insert_reference.

pub fn expanded_text(&self) -> String

Returns text with every atomic reference expanded to its payload.

pub fn insert_reference(&mut self, marker: &str, payload: &str) -> BufferOutcome

Inserts an atomic reference at the cursor: marker is displayed, navigated, and deleted as one unit, and expands to payload in the submitted text. marker must be a single line.

The unit is tracked by position, not by content: typed text that happens to equal marker stays ordinary text.

pub fn atom_ranges(&self) -> SmallVec<(usize, usize), 4>

Byte ranges of atomic markers present in the text, ascending. Slice EditBuffer::text with a range to recover the marker.

pub fn clear_after_submit(&mut self) -> String

Returns expanded text and resets the buffer after submission.

pub fn handle( &mut self, key: Key, width: u16, page_rows: usize, ) -> BufferOutcome

Applies a decoded editor key at the given layout width.

pub fn rows( &self, width_limit: u16, max_rows: usize, ) -> SmallVec<VisualRow<'_>, 8>

Returns the visible visual rows.

Keyboard editing keeps the cursor in view. A manual viewport scroll remains detached until the next editing command.

pub fn scroll_rows(&self, delta: i32, width_limit: u16, max_rows: usize) -> bool

Moves the visible row window without moving the cursor.

Returns whether the clamped viewport offset changed.

pub fn visual_height(&self, width: u16, max_rows: usize) -> usize

Returns the clipped visual row count.

pub fn at_visual_start(&self) -> bool

Reports whether the cursor is at the document’s visual start.

pub fn at_visual_end(&self) -> bool

Reports whether the cursor is at the document’s visual end.

Trait Implementations

impl Clone for EditBuffer

fn clone(&self) -> EditBuffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EditBuffer

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

Formats the value using the given formatter.

impl Default for EditBuffer

fn default() -> Self

Returns the “default value” for a type.