Struct dialoguer::Input

pub struct Input<'a, T> { /* fields omitted */ }

Renders a simple input prompt.

Example usage

use dialoguer::Input;

let name = Input::<String>::new().with_prompt("Your name").interact()?;
println!("Name: {}", name);

Methods

impl<'a, T> Input<'a, T> where
    T: Clone + FromStr + Display,
    T::Err: Display + Debug, 

pub fn new() -> Input<'static, T>

Creates a new input prompt.

pub fn with_theme(theme: &'a dyn Theme) -> Input<'a, T>

Creates an input with a specific theme.

pub fn with_prompt(&mut self, prompt: &str) -> &mut Input<'a, T>

Sets the input prompt.

pub fn with_initial_text(&mut self, val: &str) -> &mut Input<'a, T>

Sets whether the default can be editable.

pub fn default(&mut self, value: T) -> &mut Input<'a, T>

Sets a default.

Out of the box the prompt does not have a default and will continue to display until the user hit enter. If a default is set the user can instead accept the default with enter.

pub fn allow_empty(&mut self, val: bool) -> &mut Input<'a, T>

Enables or disables an empty input

By default, if there is no default value set for the input, the user must input a non-empty string.

pub fn show_default(&mut self, val: bool) -> &mut Input<'a, T>

Disables or enables the default value display.

The default is to append [default] to the prompt to tell the user that a default is acceptable.

pub fn validate_with<V: Validator + 'static>(
    &mut self,
    validator: V
) -> &mut Input<'a, T>

Registers a validator.

Example

let mail: String = Input::new()
    .with_prompt("Enter email")
    .validate_with(|input: &str| -> Result<(), &str> {
        if input.contains('@') {
            Ok(())
        } else {
            Err("This is not a mail address")
        }
    })
    .interact()
    .unwrap();

pub fn interact(&self) -> Result<T>

Enables user interaction and returns the result.

If the user confirms the result is true, false otherwise. The dialog is rendered on stderr.

pub fn interact_on(&self, term: &Term) -> Result<T>

Like interact but allows a specific terminal to be set.

Trait Implementations

impl<'a, T> Default for Input<'a, T> where
    T: Clone + FromStr + Display,
    T::Err: Display + Debug, 

fn default() -> Input<'a, T>

Returns the "default value" for a type.