Struct Input 

pub struct Input<'a> {
    pub title: String,
    pub description: String,
    pub prompt: String,
    pub placeholder: String,
    pub suggestions: Option<&'a [&'a str]>,
    pub inline: bool,
    pub password: bool,
    pub input: String,
    pub theme: &'a Theme,
    pub validation: Box<dyn InputValidator>,
    /* private fields */
}

Single line text input

Example

use demand::Input;

let input = Input::new("What's your name?")
  .description("We'll use this to personalize your experience.")
  .placeholder("Enter your name");
let name = match input.run() {
  Ok(value) => value,
  Err(e) => {
      if e.kind() == std::io::ErrorKind::Interrupted {
          println!("Input cancelled");
          return;
      } else {
          panic!("Error: {}", e);
      }
  }
};

Fields

title: String

The title of the input

description: String

A description to display after the title

prompt: String

A prompt to display after the description

placeholder: String

A placeholder to display in the input

suggestions: Option<&'a [&'a str]>

A list of suggestions to autocomplete from (legacy, prefer using autocomplete())

inline: bool

Show the input inline

password: bool

Whether to mask the input

input: String

Input entered by the user

theme: &'a Theme

Colors/style of the input

validation: Box<dyn InputValidator>

Validation function

Implementations

impl<'a> Input<'a>

pub fn new<S: Into<String>>(title: S) -> Self

Creates a new input with the given title.

pub fn description(self, description: &str) -> Self

Sets the description of the input.

If the input is inline, it is displayed to the right of the title. Otherwise, it is displayed below the title.

pub fn inline(self, inline: bool) -> Self

Sets the inline flag of the input.

If true, the input is displayed inline with the title

pub fn password(self, password: bool) -> Self

Sets the password flag of the input.

If true, the input is masked with asterisks

pub fn placeholder(self, placeholder: &str) -> Self

Sets the placeholder of the input.

The placeholder is displayed in the input before the user enters any text

pub fn suggestions(self, suggestions: &'a [&'a str]) -> Self

Sets the suggestions of the input (legacy method)

pub fn autocomplete<A: Autocomplete + 'static>(self, autocompleter: A) -> Self

Sets a custom autocompleter for the input.

The autocompleter will be used to generate suggestions and completions based on user input.

pub fn autocomplete_fn<F>(self, suggester: F) -> Self

where F: Fn(&str) -> Result<Vec<String>, Box<dyn Error>> + Clone + 'static,

Sets a function-based autocompleter for the input.

The function receives the current input and should return a list of suggestions.

pub fn max_suggestions_display(self, max: usize) -> Self

Sets the maximum number of suggestions to display

pub fn prompt(self, prompt: &str) -> Self

Sets the prompt of the input.

The prompt is displayed after the title and description. If empty, the default prompt > is displayed.

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

Sets the default value of the input.

pub fn theme(self, theme: &'a Theme) -> Self

Sets the theme of the input

pub fn validation(self, validation: fn(&str) -> Result<(), &str>) -> Self

Sets the validation for the input.

If the input is valid, the Result is Ok(()). Otherwise, the Result is Err(&str).

pub fn validator(self, validation: impl InputValidator + 'static) -> Self

Sets the validator for the input.

This is similar to the Input::validation method, but it’s more flexible. See InputValidator for examples

pub fn run(self) -> Result<String>

Displays the input to the user and returns the response

This function will block until the user submits the input. If the user cancels the input, an error of type io::ErrorKind::Interrupted is returned.