Struct Input 

pub struct Input { /* private fields */ }

A one-line text input field.

Implementations

impl Input

pub fn new( key: FieldKey<String>, question: impl Into<String>, initial_value: impl Into<String>, ) -> Result<Self, FieldConfigError>

Creates an input with a typed key, prompt question, and initial value.

pub fn placeholder(self, placeholder: impl Into<String>) -> Self

Sets text shown when the current value is empty. placeholder is plain text. Escape sequences in it are counted as ordinary characters when the prompt measures its cells, so a pre-styled string mis-aligns the field; style it through the prompt’s theme instead.

pub fn description(self, description: impl Into<String>) -> Self

Sets supporting text shown below the question. description is plain text. Escape sequences in it are counted as ordinary characters when the prompt measures its cells, so a pre-styled string mis-aligns the field; style it through the prompt’s theme instead.

pub fn help(self, help: impl Into<String>) -> Self

Sets the navigation hint shown beneath the field. help is plain text. Escape sequences in it are counted as ordinary characters when the prompt measures its cells, so a pre-styled string mis-aligns the field; style it through the prompt’s theme instead.

pub fn required(self) -> Self

Requires a non-empty value before the form can advance.

pub fn required_message(self, message: impl Into<String>) -> Self

Sets the message shown when a required input is empty.

pub fn validate(self, validator: Validator<String>) -> Self

Appends a synchronous validator, evaluated after the required check.

pub fn question(&self) -> &str

Returns the prompt question.

pub fn value(&self) -> &str

Returns the current input value.