Struct TextInputState 

pub struct TextInputState<P = TextInputProvider>
where
    P: TextInputDataProvider,
{ /* private fields */ }

Single-line text input widget state.

Wraps a single-field TextFormState. Editing, cursor, and movement methods from the form are available directly, and the form can be reached explicitly via TextInputState::form / TextInputState::form_mut. With the validation and computed features enabled, the corresponding helper methods are re-exposed as inherent methods on this type.

Implementations

impl<P> TextInputState<P>

where P: TextInputDataProvider,

pub fn with_provider(provider: P) -> TextInputState<P>

pub fn from_text<S>(text: S) -> TextInputState<P>

where S: Into<String>,

pub fn text(&self) -> String

pub fn set_text<S>(&mut self, text: S)

where S: Into<String>,

pub fn set_placeholder<S>(&mut self, s: S)

where S: Into<String>,

pub fn suggestion_suffix(&self) -> Option<&str>

pub fn set_suggestion_suffix<S>(&mut self, suffix: S)

where S: Into<String>,

pub fn clear_suggestion_suffix(&mut self)

pub fn accept_suggestion_suffix(&mut self) -> TextInputEventOutcome

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

pub fn paste(&mut self, text: &str) -> TextInputEventOutcome

pub fn update_cursor_style(&self) -> Result<(), Error>

Update terminal cursor style for this single-line input.

Follows the editor’s current mode so that Helix/Vim-style modal editing produces the correct cursor: a steady block in normal mode, a beam in insert mode, and a blinking block for selections.

pub fn handle_event(&mut self, event: Event) -> TextInputEventOutcome

pub fn input(&mut self, key: KeyEvent) -> TextInputEventOutcome

pub fn cursor(&self, area: Rect, block: Option<&Block<'_>>) -> (u16, u16)

impl<P> TextInputState<P>

where P: TextInputDataProvider,

pub fn form(&self) -> &TextFormState<P>

Borrow the underlying TextFormState.

pub fn form_mut(&mut self) -> &mut TextFormState<P>

Mutably borrow the underlying TextFormState.

pub fn current_field(&self) -> usize

pub fn cursor_position(&self) -> usize

pub fn current_text(&self) -> &str

pub fn mode(&self) -> AppMode

pub fn ui_state(&self) -> &EditorState

pub fn data_provider(&self) -> &P

pub fn data_provider_mut(&mut self) -> &mut P

pub fn move_left(&mut self) -> Result<(), Error>

pub fn move_right(&mut self) -> Result<(), Error>

pub fn move_line_start(&mut self)

pub fn move_line_end(&mut self)

pub fn set_cursor_position(&mut self, position: usize)

pub fn enter_edit_mode(&mut self)

pub fn exit_edit_mode(&mut self) -> Result<(), Error>

pub fn insert_char(&mut self, ch: char) -> Result<(), Error>

pub fn insert_text(&mut self, text: &str) -> Result<(), Error>

pub fn set_current_field_value(&mut self, value: String)

pub fn delete_backward(&mut self) -> Result<(), Error>

pub fn delete_forward(&mut self) -> Result<(), Error>

pub fn move_word_next(&mut self)

Move to the start of the next word.

pub fn move_word_prev(&mut self)

Move to the start of the previous word.

pub fn move_word_end(&mut self)

Move to the end of the current/next word.

pub fn move_word_end_prev(&mut self)

Move to the end of the previous word.

pub fn move_big_word_next(&mut self)

Move to the start of the next WORD (whitespace-delimited, vim W).

pub fn move_big_word_prev(&mut self)

Move to the start of the previous WORD (vim B).

pub fn move_big_word_end(&mut self)

Move to the end of the current/next WORD (vim E).

pub fn move_big_word_end_prev(&mut self)

Move to the end of the previous WORD (vim gE).

pub fn enter_append_mode(&mut self)

Enter edit mode with the cursor positioned for append (vim a).

pub fn current_display_text(&self) -> String

The current field’s display text (mask/formatter-aware when the validation feature is enabled; otherwise the raw text).

pub fn display_cursor_position(&self) -> usize

Cursor position in display coordinates (accounts for a display mask).

impl<P> TextInputState<P>

where P: TextInputDataProvider,

Validation helpers, re-exposed from the underlying TextFormState so they are part of TextInputState’s own public API.

pub fn set_validation_enabled(&mut self, enabled: bool)

pub fn is_validation_enabled(&self) -> bool

pub fn set_field_validation( &mut self, field_index: usize, config: ValidationConfig, )

pub fn remove_field_validation(&mut self, field_index: usize)

pub fn validate_current_field(&mut self) -> ValidationResult

pub fn validate_field(&mut self, field_index: usize) -> Option<ValidationResult>

pub fn clear_validation_results(&mut self)

pub fn validation_summary(&self) -> ValidationSummary

pub fn can_switch_fields(&self) -> bool

pub fn field_switch_block_reason(&self) -> Option<String>

pub fn last_switch_block(&self) -> Option<&str>

pub fn current_limits_status_text(&self) -> Option<String>

pub fn current_formatter_warning(&self) -> Option<String>

pub fn external_validation_of( &self, field_index: usize, ) -> ExternalValidationState

pub fn clear_all_external_validation(&mut self)

pub fn clear_external_validation(&mut self, field_index: usize)

pub fn set_external_validation( &mut self, field_index: usize, state: ExternalValidationState, )

pub fn set_external_validation_callback<F>(&mut self, callback: F)

where F: FnMut(usize, &str) -> ExternalValidationState + Send + Sync + 'static,

impl<P> TextInputState<P>

where P: TextInputDataProvider,

Computed-field helpers, re-exposed from the underlying TextFormState.

pub fn register_computed_provider<C>(&mut self, provider: &C)

where C: ComputedProvider,

pub fn set_computed_provider<C>(&mut self, provider: C)

where C: ComputedProvider,

pub fn recompute_fields<C>(&mut self, provider: &mut C, field_indices: &[usize])

where C: ComputedProvider,

pub fn recompute_all_fields<C>(&mut self, provider: &mut C)

where C: ComputedProvider,

pub fn on_field_changed<C>(&mut self, provider: &mut C, changed_field: usize)

where C: ComputedProvider,

pub fn effective_field_value(&self, field_index: usize) -> String

impl<P> TextInputState<P>

where P: TextInputDataProvider,

Undo/redo, re-exposed from the underlying TextFormState.

pub fn undo(&mut self) -> bool

pub fn redo(&mut self) -> bool

pub fn can_undo(&self) -> bool

pub fn can_redo(&self) -> bool

pub fn clear_history(&mut self)

pub fn set_history_limit(&mut self, limit: usize)

impl<P> TextInputState<P>

where P: TextInputDataProvider,

Dropdown suggestions, re-exposed from the underlying TextFormState so that TextInput, TextArea, and TextFormState all share one suggestions mechanism. Render the dropdown with canvas::suggestions::render::render_suggestions_dropdown(.., self.form()).

This is distinct from the lightweight inline-suffix completion (TextInputState::set_suggestion_suffix), which TextInput also offers.

pub fn open_suggestions(&mut self, field_index: usize)

pub fn check_suggestion_trigger(&mut self)

pub fn trigger_suggestions(&mut self) -> Option<(usize, String)>

pub fn apply_suggestions(&mut self, items: Vec<SuggestionItem>)

pub fn update_suggestions(&mut self, items: Vec<SuggestionItem>)

pub fn dismiss_suggestions(&mut self)

pub fn cancel_suggestions(&mut self)

pub fn suggestions_next(&mut self)

pub fn suggestions_prev(&mut self)

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

pub fn is_suggestions_active(&self) -> bool

pub fn is_suggestions_loading(&self) -> bool

pub fn dropdown_suggestions(&self) -> &[SuggestionItem]

Methods from Deref<Target = TextFormState<P>>

pub fn core(&self) -> &EditorCore<D>

pub fn fixed_field_count(&self) -> usize

pub fn handle_event(&mut self, event: Event) -> TextFormEventOutcome

pub fn paste(&mut self, text: &str) -> TextFormEventOutcome

pub fn input(&mut self, key: KeyEvent) -> TextFormEventOutcome

pub fn handle_key_event(&mut self, evt: KeyEvent) -> KeyEventOutcome

pub fn is_sequence_pending(&self) -> bool

Whether a multi-key command (key sequence, count, or pending operator) is in flight, so a host should keep routing keys here rather than letting an outer keymap claim the next stroke.

pub fn update_cursor_style(&self) -> Result<(), Error>

pub fn cursor(&self, area: Rect, block: Option<&Block<'_>>) -> (u16, u16)

pub fn use_keybinding_preset(&mut self, preset: BuiltinCanvasKeybindingPreset)

pub fn set_keybindings(&mut self, keybindings: CanvasKeyBindings)

pub fn clear_current_field(&mut self)

pub fn clear_field(&mut self, field_index: usize)

pub fn clear_current_and_following_fields(&mut self, count: usize)

pub fn change_current_field(&mut self)

pub fn delete_to_field_end(&mut self)

pub fn execute(&mut self, action: CanvasAction) -> ActionResult

pub fn undo(&mut self) -> bool

pub fn redo(&mut self) -> bool

Methods from Deref<Target = EditorCore<D>>

pub fn execute(&mut self, action: CanvasAction) -> ActionResult

Execute a CanvasAction on this editor instance.

pub fn set_keybindings(&mut self, keybindings: CanvasKeyBindings)

Set the keybindings for this editor instance.

pub fn set_keybinding_preset(&mut self, preset: BuiltinCanvasKeybindingPreset)

Install a built-in keybinding preset and its editing paradigm.

pub fn has_keybindings(&self) -> bool

Check if this editor has keybindings configured.

pub fn set_key_sequence_timeout_ms(&mut self, timeout_ms: u64)

Set the timeout for multi-key sequences (in milliseconds)

pub fn current_text(&self) -> &str

pub fn current_field(&self) -> usize

pub fn cursor_position(&self) -> usize

pub fn mode(&self) -> AppMode

pub fn is_suggestions_active(&self) -> bool

pub fn ui_state(&self) -> &EditorState

pub fn data_provider(&self) -> &D

pub fn data_provider_mut(&mut self) -> &mut D

pub fn suggestions(&self) -> &[SuggestionItem]

pub fn validation_state(&self) -> &ValidationState

pub fn cleanup_cursor(&self) -> Result<(), Error>

pub fn current_display_text(&self) -> String

Get current field text for display.

pub fn display_text_for_field(&self, field_index: usize) -> String

Get effective display text for any field index (Feature 4 + masks).

pub fn display_cursor_position(&self) -> usize

Map raw cursor to display position (formatter/mask aware).

pub fn open_line_below(&mut self) -> Result<(), Error>

Open new line below (vim o)

pub fn open_line_above(&mut self) -> Result<(), Error>

Open new line above (vim O)

pub fn insert_char(&mut self, ch: char) -> Result<(), Error>

Handle character insertion (mask/limit-aware)

pub fn insert_text(&mut self, text: &str) -> Result<(), Error>

Insert plain text at the current cursor position.

This intentionally treats the input as a character stream and reuses insert_char so validation, masking, and suggestions continue to flow through the existing editing logic.

pub fn delete_backward(&mut self) -> Result<(), Error>

Delete backward (backspace)

pub fn delete_forward(&mut self) -> Result<(), Error>

Delete forward (Delete key)

pub fn enter_append_mode(&mut self)

Enter edit mode with cursor positioned for append (vim ‘a’)

pub fn set_current_field_value(&mut self, value: String)

Set current field value (validates under feature flag)

pub fn set_field_value(&mut self, field_index: usize, value: String)

Set specific field value by index (validates under feature flag)

pub fn clear_current_field(&mut self)

Clear the current field

pub fn undo(&mut self) -> bool

Undo the most recent edit (or run). Returns false if there is nothing to undo.

pub fn redo(&mut self) -> bool

Redo the most recently undone edit. Returns false if there is nothing to redo.

pub fn can_undo(&self) -> bool

Whether there is any edit to undo.

pub fn can_redo(&self) -> bool

Whether there is any undone edit to redo.

pub fn clear_history(&mut self)

Clear all undo/redo history.

pub fn set_history_limit(&mut self, limit: usize)

Set the maximum number of retained undo steps (oldest dropped first).

pub fn set_history_enabled(&mut self, enabled: bool)

Enable or disable undo/redo history capture (enabled by default).

While disabled, edits do not record checkpoints, so apps that don’t want undo — or want to avoid the per-edit snapshot cost — can switch it off. Existing history is cleared when disabling.

pub fn is_history_enabled(&self) -> bool

Whether undo/redo history capture is currently enabled.

pub fn update_inline_completion(&mut self)

Update UI state’s completion text from current selection

pub fn open_suggestions(&mut self, field_index: usize)

Open the suggestions UI for field_index

pub fn trigger_suggestions(&mut self) -> Option<(usize, String)>

Trigger suggestions - opens UI and returns request info for client to fetch data. Client should fetch data and call apply_suggestions(). Returns Some((field_index, query)) if suggestions can be triggered, None otherwise.

pub fn apply_suggestions(&mut self, items: Vec<SuggestionItem>)

Apply fetched suggestions from client - opens UI with the provided items.

pub fn update_suggestions(&mut self, items: Vec<SuggestionItem>)

Update suggestions with new query results - adjusts selection if needed.

pub fn dismiss_suggestions(&mut self)

Dismiss suggestions - closes UI and clears data.

pub fn check_suggestion_trigger(&mut self)

Check suggestion trigger condition and update suggestions accordingly. This is called automatically when entering insert mode or changing text.

pub fn handle_escape_readonly(&mut self)

Handle Escape key in normal mode (closes suggestions if active)

pub fn cancel_suggestions(&mut self)

pub fn suggestions_next(&mut self)

pub fn suggestions_prev(&mut self)

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

pub fn set_validation_enabled(&mut self, enabled: bool)

pub fn is_validation_enabled(&self) -> bool

pub fn set_field_validation( &mut self, field_index: usize, config: ValidationConfig, )

pub fn remove_field_validation(&mut self, field_index: usize)

pub fn validate_current_field(&mut self) -> ValidationResult

pub fn validate_field(&mut self, field_index: usize) -> Option<ValidationResult>

pub fn clear_validation_results(&mut self)

pub fn validation_summary(&self) -> ValidationSummary

pub fn can_switch_fields(&self) -> bool

pub fn field_switch_block_reason(&self) -> Option<String>

pub fn last_switch_block(&self) -> Option<&str>

pub fn current_limits_status_text(&self) -> Option<String>

pub fn current_formatter_warning(&self) -> Option<String>

pub fn external_validation_of( &self, field_index: usize, ) -> ExternalValidationState

pub fn clear_all_external_validation(&mut self)

pub fn clear_external_validation(&mut self, field_index: usize)

pub fn set_external_validation( &mut self, field_index: usize, state: ExternalValidationState, )

pub fn set_external_validation_callback<F>(&mut self, callback: F)

where F: FnMut(usize, &str) -> ExternalValidationState + Send + Sync + 'static,

pub fn register_computed_provider<C>(&mut self, provider: &C)

where C: ComputedProvider,

pub fn set_computed_provider<C>(&mut self, provider: C)

where C: ComputedProvider,

pub fn recompute_fields<C>(&mut self, provider: &mut C, field_indices: &[usize])

where C: ComputedProvider,

pub fn recompute_all_fields<C>(&mut self, provider: &mut C)

where C: ComputedProvider,

pub fn on_field_changed<C>(&mut self, provider: &mut C, changed_field: usize)

where C: ComputedProvider,

pub fn effective_field_value(&self, field_index: usize) -> String

pub fn set_mode(&mut self, mode: AppMode)

Change mode

pub fn exit_edit_mode(&mut self) -> Result<(), Error>

Exit insert mode to normal mode

pub fn enter_edit_mode(&mut self)

Enter insert mode

pub fn enter_highlight_mode(&mut self)

pub fn enter_highlight_line_mode(&mut self)

pub fn exit_highlight_mode(&mut self)

pub fn is_highlight_mode(&self) -> bool

pub fn selection_state(&self) -> &SelectionState

pub fn move_left_with_selection(&mut self)

pub fn move_right_with_selection(&mut self)

pub fn move_up_with_selection(&mut self)

pub fn move_down_with_selection(&mut self)

pub fn move_word_next_with_selection(&mut self)

pub fn move_word_end_with_selection(&mut self)

pub fn move_word_prev_with_selection(&mut self)

pub fn move_word_end_prev_with_selection(&mut self)

pub fn move_big_word_next_with_selection(&mut self)

pub fn move_big_word_end_with_selection(&mut self)

pub fn move_big_word_prev_with_selection(&mut self)

pub fn move_big_word_end_prev_with_selection(&mut self)

pub fn move_line_start_with_selection(&mut self)

pub fn move_line_end_with_selection(&mut self)

pub fn move_left(&mut self) -> Result<(), Error>

Move cursor left within current field (mask-aware)

pub fn move_right(&mut self) -> Result<(), Error>

Move cursor right within current field (mask-aware)

pub fn move_line_start(&mut self)

Move to start of current field (vim 0)

pub fn move_line_end(&mut self)

Move to end of current field (vim $)

pub fn set_cursor_position(&mut self, position: usize)

Set cursor to exact position (for f/F/t/T etc.)

pub fn move_word_next(&mut self)

Move to start of next word (vim w) - can cross field boundaries

pub fn move_word_prev(&mut self)

Move to start of previous word (vim b) - can cross field boundaries

pub fn move_word_end(&mut self)

Move to end of current/next word (vim e) - can cross field boundaries

pub fn move_word_end_prev(&mut self)

Move to end of previous word (vim ge) - can cross field boundaries

pub fn move_big_word_next(&mut self)

Move to start of next big_word (vim W) - can cross field boundaries

pub fn move_big_word_prev(&mut self)

Move to start of previous big_word (vim B) - can cross field boundaries

pub fn move_big_word_end(&mut self)

Move to end of current/next big_word (vim E) - can cross field boundaries

pub fn move_big_word_end_prev(&mut self)

Move to end of previous big_word (vim gE) - can cross field boundaries

pub fn transition_to_field(&mut self, new_field: usize) -> Result<(), Error>

pub fn move_first_line(&mut self) -> Result<(), Error>

Move to first line (vim gg)

pub fn move_last_line(&mut self) -> Result<(), Error>

Move to last line (vim G)

pub fn move_up(&mut self) -> bool

Move to previous field (vim k / up) Returns true if moved, false if already at top

pub fn move_down(&mut self) -> bool

Move to next field (vim j / down) Returns true if moved, false if already at bottom

pub fn move_to_next_field(&mut self) -> Result<(), Error>

Move to next field cyclic

pub fn prev_field(&mut self) -> bool

pub fn next_field(&mut self) -> bool

Trait Implementations

impl<P> CanvasTextInputHost for TextInputState<P>

where P: TextInputDataProvider,

fn mode(&self) -> AppMode

fn text(&self) -> String

fn has_keybindings(&self) -> bool

fn install_keybindings(&mut self, bindings: CanvasKeyBindings)

fn is_sequence_pending(&self) -> bool

Whether a multi-key command is mid-flight, so the runtime keeps routing keys here instead of letting the global keymap claim the next stroke.

fn input_key(&mut self, key: KeyEvent) -> CanvasKeyDispatchOutcome

fn accept_suggestion_suffix(&mut self) -> bool

Accept the current inline-suggestion suffix (ghost text). Returns whether a non-empty suffix was inserted.

fn paste(&mut self, text: &str) -> bool

Insert pasted (bracketed-paste) text. Returns whether anything was inserted.

fn set_suggestion_suffix(&mut self, suffix: String)

fn clear_suggestion_suffix(&mut self)

fn exit_edit_mode(&mut self)

fn dispatch_canvas_action(&mut self, action: CanvasAction) -> HostActionOutcome

impl<P> Default for TextInputState<P>

where P: TextInputDataProvider + Default,

fn default() -> TextInputState<P>

Returns the “default value” for a type.

impl<P> Deref for TextInputState<P>

where P: TextInputDataProvider,

type Target = TextFormState<P>

The resulting type after dereferencing.

fn deref(&self) -> &<TextInputState<P> as Deref>::Target

Dereferences the value.

impl<P> DerefMut for TextInputState<P>

where P: TextInputDataProvider,

fn deref_mut(&mut self) -> &mut <TextInputState<P> as Deref>::Target

Mutably dereferences the value.