Struct TextInput 

pub struct TextInput { /* private fields */ }

Single-line editable text with a cursor. cursor is a byte offset into buf, always kept on a char boundary and within 0..=buf.len().

Implementations

impl TextInput

pub fn new() -> Self

Empty buffer, cursor at the start.

pub fn with_text(text: impl Into<String>) -> Self

Seed with existing text, cursor at the end — the natural spot when editing a pre-filled value (e.g. a rename).

pub fn text(&self) -> &str

The current text.

pub fn trimmed(&self) -> &str

The text with surrounding whitespace trimmed (for accept-time validation).

pub fn is_empty(&self) -> bool

True when the buffer is empty.

pub fn clear(&mut self)

Empty the buffer and reset the cursor to the start.

pub fn cursor_col(&self) -> usize

Display column of the cursor — the number of characters before it. Renderers add this to the input box’s left edge to place the terminal cursor.

pub fn insert(&mut self, c: char)

Insert a character at the cursor, advancing past it.

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

Insert a string at the cursor (paste), advancing past it.

pub fn backspace(&mut self)

Delete the char before the cursor (Backspace). No-op at the start.

pub fn delete_forward(&mut self)

Delete the char at the cursor (Delete). No-op at the end.

pub fn delete_word_back(&mut self)

Delete the word before the cursor (Ctrl-W): the run of trailing spaces, then the run of non-space chars up to the previous space.

pub fn left(&mut self)

Move the cursor one char left.

pub fn right(&mut self)

Move the cursor one char right.

pub fn home(&mut self)

Move the cursor to the start.

pub fn end(&mut self)

Move the cursor to the end.

pub fn handle_key(&mut self, key: KeyEvent) -> bool

Apply a single editing keypress. Returns true if the key was an editing action (consumed), false if the caller should handle it (Enter/Esc/Tab/…). Ctrl/Alt/Super-modified keys other than the recognised emacs-style chords are left unhandled so global chords (and OS shortcuts like Cmd+V on terminals that report the Super modifier) still reach the dispatcher rather than being typed as text.

Trait Implementations

impl Clone for TextInput

fn clone(&self) -> TextInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextInput

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

Formats the value using the given formatter.

impl Default for TextInput

fn default() -> TextInput

Returns the “default value” for a type.

impl Eq for TextInput

impl From<&str> for TextInput

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for TextInput

fn from(s: String) -> Self

Converts to this type from the input type.

impl PartialEq for TextInput

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TextInput