Struct TextInputState 

pub struct TextInputState {
    pub value: String,
    pub cursor: usize,
    pub placeholder: String,
    pub max_length: Option<usize>,
    pub validation_error: Option<String>,
    pub masked: bool,
    pub suggestions: Vec<String>,
    pub suggestion_index: usize,
    pub show_suggestions: bool,
    /* private fields */
}

State for a single-line text input widget.

Pass a mutable reference to Context::text_input each frame. The widget handles all keyboard events when focused.

Example

let mut input = TextInputState::with_placeholder("Type here...");
ui.text_input(&mut input);
println!("{}", input.value);

Fields

value: String

The current input text.

cursor: usize

Cursor position as a character index into value.

placeholder: String

Placeholder text shown when value is empty.

max_length: Option<usize>

Maximum character count. Input is rejected beyond this limit.

validation_error: Option<String>

The most recent validation error message, if any.

masked: bool

When true, input is displayed as • characters (for passwords).

suggestions: Vec<String>

Autocomplete candidates shown below the input.

suggestion_index: usize

Highlighted index within the currently shown suggestions.

show_suggestions: bool

Whether the suggestions popup should be rendered.

Implementations

impl TextInputState

pub fn new() -> Self

Create an empty text input state.

pub fn with_placeholder(p: impl Into<String>) -> Self

Create a text input with placeholder text shown when the value is empty.

pub fn max_length(self, len: usize) -> Self

Set the maximum allowed character count.

pub fn validate(&mut self, validator: impl Fn(&str) -> Result<(), String>)

Validate the current value and store the latest error message.

Sets TextInputState::validation_error to None when validation succeeds, or to Some(error) when validation fails.

This is a backward-compatible shorthand that runs a single validator. For multiple validators, use add_validator and run_validators.

pub fn add_validator( &mut self, f: impl Fn(&str) -> Result<(), String> + 'static, )

Add a validator function that produces its own error message.

Multiple validators can be added. Call run_validators to execute all validators and collect their errors.

Note on cloning

Validators are not preserved across Clone because closures are not Clone. Re-register after cloning the state.

pub fn run_validators(&mut self)

Run all registered validators and collect their error messages.

Updates validation_errors with all errors from all validators. Also updates validation_error to the first error for backward compatibility.

Note on cloning

Validators do not survive Clone. Calling this on a cloned state with no re-registered validators clears validation_errors without re-running any check. Re-register validators on the clone first.

pub fn errors(&self) -> &[String]

Get all current validation errors from all validators.

pub fn set_suggestions(&mut self, suggestions: Vec<String>)

Set autocomplete suggestions and reset popup state.

pub fn matched_suggestions(&self) -> Vec<&str>

Return suggestions that start with the current input (case-insensitive).

Trait Implementations

impl Clone for TextInputState

fn clone(&self) -> Self

Clone behavior

validators registered via TextInputState::add_validator are not cloned because closures are not Clone. validation_errors is preserved in the clone, but it becomes stale — calling TextInputState::run_validators on the clone will clear errors without re-running any validation.

Re-register validators on the clone before calling run_validators().

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

Performs copy-assignment from source.

impl Debug for TextInputState

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

Formats the value using the given formatter.

impl Default for TextInputState

fn default() -> Self

Returns the “default value” for a type.