Struct PromptInput 

pub struct PromptInput { /* private fields */ }

A cursor-aware text buffer used for the prompt input line.

The cursor is stored as a grapheme cluster index so that combining marks, emoji sequences, and other multi-codepoint clusters are treated as a single unit. It is always in the range 0..=grapheme_count.

Implementations

impl PromptInput

pub fn new() -> Self

Create an empty input.

pub fn as_str(&self) -> &str

The full text content.

pub fn text(&self) -> String

The full text content, owned.

pub fn cursor(&self) -> usize

Current cursor position as a grapheme-cluster index.

pub fn len_graphemes(&self) -> usize

Number of grapheme clusters in the buffer.

pub fn graphemes(&self) -> Graphemes<'_>

Iterator over the grapheme clusters.

pub fn is_empty(&self) -> bool

Whether the buffer is empty.

pub fn clear(&mut self)

Clear all text and reset the cursor.

pub fn set_text(&mut self, s: &str)

Set the text to s, placing the cursor at the end.

pub fn cursor_left(&mut self)

Move the cursor left by one grapheme cluster (clamped at 0).

pub fn cursor_right(&mut self)

Move the cursor right by one grapheme cluster (clamped at end).

pub fn cursor_to_start(&mut self)

Move the cursor to the start of the line (grapheme index 0).

pub fn cursor_to_end(&mut self)

Move the cursor to the end of the text.

pub fn cursor_up(&mut self) -> bool

Move the cursor to the previous logical line, preserving the column as closely as possible. Returns true when the cursor moved.

pub fn cursor_down(&mut self) -> bool

Move the cursor to the next logical line, preserving the column as closely as possible. Returns true when the cursor moved.

pub fn cursor_word_left(&mut self)

Move the cursor left to the start of the previous Unicode word.

Uses unicode-segmentation word boundaries so that punctuation, numbers, and other non-whitespace runs are treated as word units.

pub fn cursor_word_right(&mut self)

Move the cursor right to the start of the next Unicode word.

Uses unicode-segmentation word boundaries so that punctuation, numbers, and other non-whitespace runs are treated as word units.

pub fn insert_char(&mut self, ch: char)

Insert a character at the cursor, then advance the cursor past it.

pub fn insert_str(&mut self, s: &str)

Insert a string at the cursor, advancing the cursor to the end of the inserted text.

pub fn replace_range(&mut self, start: usize, end: usize, replacement: &str)

Replace a grapheme-cluster range and place the cursor after the inserted text.

pub fn backspace(&mut self) -> bool

Delete the grapheme cluster to the left of the cursor (backspace).

Returns true if a grapheme was deleted.

pub fn delete_forward(&mut self) -> bool

Delete the grapheme cluster to the right of the cursor (forward delete).

Returns true if a grapheme was deleted.

pub fn kill_to_end_of_line(&mut self) -> String

Kill from the cursor to the end of the line. Returns the killed text.

pub fn kill_to_start_of_line(&mut self) -> String

Kill from the start of the line to the cursor. Returns the killed text.

pub fn kill_word_left(&mut self) -> String

Kill the word before the cursor (unix-word-rubout style). Uses Unicode word boundaries. Returns the killed text.

pub fn kill_word_right(&mut self) -> String

Kill the word after the cursor. Uses Unicode word boundaries. Returns the killed text.

pub fn transpose_chars(&mut self) -> bool

Transpose the grapheme clusters at the cursor and just before it. Returns true if a transposition happened.

At the start of the line, swaps the first two graphemes and moves the cursor past both. In the middle, swaps the grapheme before and at the cursor, then advances. At the end, swaps the last two graphemes.

pub fn yank(&mut self, text: &str)

Yank (paste) text at the cursor, advancing the cursor past it.

pub fn text_before_cursor(&self) -> &str

The text before the cursor.

Trait Implementations

impl Clone for PromptInput

fn clone(&self) -> PromptInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptInput

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

Formats the value using the given formatter.

impl Default for PromptInput

fn default() -> PromptInput

Returns the “default value” for a type.

impl Eq for PromptInput

impl From<&str> for PromptInput

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for PromptInput

fn from(s: String) -> Self

Converts to this type from the input type.

impl FromStr for PromptInput

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for PromptInput

fn eq(&self, other: &PromptInput) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PromptInput