Struct inquire::Text

pub struct Text<'a> {
    pub message: &'a str,
    pub default: Option<&'a str>,
    pub help_message: Option<&'a str>,
    pub formatter: fn(answer: &str) -> &str,
    pub validators: Vec<StringValidator<'a>>,
    pub page_size: usize,
    pub suggester: Option<Suggester>,
}

Presents a message to the user and retrieves 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: fn(answer: &str) -> &str

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. Validation errors are 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>

Function that provides a list of suggestions to the user based on the current input.

Implementations

impl<'a> Text<'a>

pub const DEFAULT_PAGE_SIZE: usize

Default page size, equal to the global default page size config::DEFAULT_PAGE_SIZE

pub const DEFAULT_FORMATTER: fn(answer: &str) -> &str

Default formatter.

pub const DEFAULT_VALIDATORS: Vec<StringValidator<'a>>

Default collection of validators.

pub const DEFAULT_HELP_MESSAGE: Option<&'a str>

Default help message.

pub fn new(message: &'a str) -> Self

Creates a Text with the provided message and default options.

pub fn with_help_message(self, message: &'a str) -> Self

Sets the help message of the prompt.

pub fn with_default(self, message: &'a str) -> Self

Sets the default input.

pub fn with_suggester(self, suggester: Suggester) -> Self

Sets the suggester.

pub fn with_formatter(self, formatter: fn(answer: &str) -> &str) -> Self

Sets the formatter

pub fn with_validator(self, validator: StringValidator<'a>) -> Self

Adds a validator to the collection of validators.

pub fn with_validators(self, validators: &[StringValidator<'a>]) -> Self

Adds the validators to the collection of validators.

pub fn prompt(self) -> InquireResult<String>

Parses the provided behavioral and rendering options and prompts the CLI user for input according to them.

Trait Implementations

impl<'a> Clone for Text<'a>

fn clone(&self) -> Text<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> From<&'a str> for Text<'a>

fn from(val: &'a str) -> Self

Performs the conversion.