Struct PromptBuffer 

pub struct PromptBuffer { /* private fields */ }

Implementations

impl PromptBuffer

pub fn new() -> Self

pub fn is_empty(&self) -> bool

pub fn as_string(&self) -> String

Joined string with embedded \n between rows. Allocates.

pub fn height(&self) -> usize

Number of rows in the current buffer. Always ≥ 1.

pub const fn cursor_row(&self) -> usize

Current cursor row (0-based).

pub const fn cursor(&self) -> usize

Current cursor column on the active row.

pub fn cursor_column(&self) -> u16

Same as [cursor] but as a u16 for ratatui’s column API.

pub fn line(&self, row: usize) -> Option<&[char]>

Read a row’s contents — used by the widget for rendering.

pub const fn history(&self) -> &PromptHistory

Borrowed access to the history ring (read-only).

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

Insert a literal character at the cursor. Discards the history-recall flag — once you start typing on a recalled entry it’s part of your draft.

pub fn insert_newline(&mut self)

Shift+Enter — break the current line at the cursor and move down. Capped at MAX_LINES; further newlines are silently dropped so a stuck Repeat key cannot grow the prompt indefinitely.

pub fn backspace(&mut self)

Backspace — delete the char to the left of the cursor; if at column 0 of a non-first row, merge with the previous row instead.

pub fn delete(&mut self)

Delete — char at the cursor, or if at end of line, splice the next line up.

pub fn move_left(&mut self)

pub fn move_right(&mut self)

pub fn move_home(&mut self)

pub fn move_end(&mut self)

pub fn move_up(&mut self)

Up arrow — intra-buffer movement. The caller (input.rs) is responsible for routing Up to history recall when the cursor is at the first row; this method only moves up inside a multi-line buffer.

pub fn move_down(&mut self)

pub const fn cursor_on_first_row(&self) -> bool

True when the cursor is on the visual top row of the buffer. Input router uses this to decide whether Up should recall history or move within the buffer.

pub fn cursor_on_last_row(&self) -> bool

True when the cursor is on the visual last row.

pub fn recall_prev(&mut self)

Recall the previous (older) history entry. Stashes the live draft on first use so a subsequent recall_next past the newest can restore it.

pub fn recall_next(&mut self)

Recall the next (newer) history entry, or restore the saved draft when stepping past the newest entry.

pub fn take(&mut self) -> Option<String>

Submit the buffer. Returns None for an all-whitespace buffer so the caller can short-circuit. Also pushes the joined text onto history and resets the recall cursor.

pub fn clear(&mut self)

Discard the buffer and reset the cursor, but keep history intact. Used by Esc.

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

Replace the whole buffer with a literal value (used by the slash-command picker on Tab-complete). Cursor lands at end-of-buffer.

Trait Implementations

impl Debug for PromptBuffer

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

Formats the value using the given formatter.

impl Default for PromptBuffer

fn default() -> Self

Returns the “default value” for a type.