Struct inquire::Text [−][src]
pub struct Text<'a> { pub message: &'a str, pub default: Option<&'a str>, pub help_message: Option<&'a str>, pub formatter: StringFormatter<'a>, pub validators: Vec<StringValidator<'a>>, pub page_size: usize, pub suggester: Option<Suggester<'a>>, }
Expand description
Prompts the user for a single line of text input.
Fields
message: &'a str
Message to be presented to the user.
default: Option<&'a str>
Default value, returned when the user input is empty.
help_message: Option<&'a str>
Help message to be presented to the user.
formatter: StringFormatter<'a>
Function that formats the user input and presents it to the user as the final rendering of the prompt.
validators: Vec<StringValidator<'a>>
Collection of validators to apply to the user input.
Validators are executed in the order they are stored, stopping at and displaying to the user only the first validation error that might appear.
The possible error is displayed to the user one line above the prompt.
page_size: usize
Page size of the suggestions displayed to the user, when applicable.
suggester: Option<Suggester<'a>>
Function that provides a list of suggestions to the user based on the current input.
Implementations
Default formatter, set to DEFAULT_STRING_FORMATTER
Default page size, equal to the global default page size config::DEFAULT_PAGE_SIZE
Default validators added to the Text prompt, none.
Default help message.
Creates a Text with the provided message and default options.
Sets the help message of the prompt.
Sets the default input.
Sets the suggester.
Sets the formatter.
Sets the page size
Adds a validator to the collection of validators. You might want to use this feature in case you need to require certain features from the user’s answer, such as defining a limit of characters.
Validators are executed in the order they are stored, stopping at and displaying to the user only the first validation error that might appear.
The possible error is displayed to the user one line above the prompt.
Adds the validators to the collection of validators in the order they are given. You might want to use this feature in case you need to require certain features from the user’s answer, such as defining a limit of characters.
Validators are executed in the order they are stored, stopping at and displaying to the user only the first validation error that might appear.
The possible error is displayed to the user one line above the prompt.
Parses the provided behavioral and rendering options and prompts the CLI user for input according to the defined rules.
Trait Implementations
Auto Trait Implementations
impl<'a> !RefUnwindSafe for Text<'a>
impl<'a> !UnwindSafe for Text<'a>
Blanket Implementations
Mutably borrows from an owned value. Read more