Struct Input 

pub struct Input<F> { /* private fields */ }

This is a normal text input prompt with the following features:

• Custom label
• Validation of the input with error reporting
• Transformation of the text input to arbitrary Rust type
• Optional default value
• Optional help message
• Customizable colors and formatting

use cli_prompts::{
    prompts::{Input, AbortReason::{self, Error}},
    style::{InputStyle, Formatting},
    DisplayPrompt
};

fn validate_and_transform(input: &str) -> Result<u16, String> {
    input
      .parse::<u16>()
      .map_err(|e| "Provided input is not a valid time of the day".into())
      .and_then(|n| if n <= 24 { Ok(n) } else { Err("Provided input is not a valid time of the day".into()) })
}

fn main() {
    let input = Input::new("At what time do you usually eat lunch?", validate_and_transform)
        .default_value("12")
        .help_message("Enter an hour of the day as a number from 0 to 24")
        .style(InputStyle::default()
                  .default_value_formatting(Formatting::default().bold())
         );

    let lunch_time : Result<u16, AbortReason> = input.display();
    match lunch_time {
        Ok(time) => println!("You eat lunch at {} o'clock", time),
        Err(abort_reason) => match abort_reason {
            Interrupt => println!("The prompt was interrupted by pressing the ESC key"),
            Error(err) => println!("I/O error has occured: {:?}", err),
        }
    }
     
}

Implementations

impl<F, T> Input<F>

where F: Fn(&str) -> Result<T, String>,

pub fn new(label: impl Into<String>, validation: F) -> Self

Constructs an input prompt with a given label and a validation function The function serves both as validator and transformer: it should return Ok of the arbitrary type T if validation passed and Err(String) if it failed. The containing String will be displayed as an error message and the prompt will continue until this function returns Ok

Examples found in repository

examples/styling.rs (line 30)

fn main() -> Result<()> {
    let label_style = LabelStyle::default()
        .prefix("*")
        .prefix_formatting(Formatting::default().foreground_color(Color::Cyan))
        .prompt_formatting(
            Formatting::default()
                .bold()
                .underline()
                .foreground_color(Color::Magenta),
        );
    let input_formatting = Formatting::default().foreground_color(Color::Cyan);
    let submitted_formatting = Formatting::default().foreground_color(Color::DarkCyan);

    let name = Input::new("Enter your name", name_validation)
        .style(
            InputStyle::default()
                .label_style(label_style.clone())
                .input_formatting(input_formatting.clone())
                .submitted_formatting(submitted_formatting.clone()),
        )
        .display();
    let coffee = Confirmation::new("Do you want a cup of coffee")
        .style(
            ConfirmationStyle::default()
                .label_style(label_style.clone())
                .input_formatting(input_formatting.clone())
                .submitted_formatting(submitted_formatting.clone()),
        )
        .display();

    println!("Name: {:?}", name);
    println!("Coffee: {:?}", coffee);

    Ok(())
}

examples/general.rs (line 42)

fn main() {
    let desserts = [
        "Tiramisu",
        "Cheesecake",
        "Brownee",
        "Cookie",
        "Jelly",
        "Chupa-Chups",
        "Pudding",
    ];
    let subjects = [
        "Physics",
        "Math",
        "Polish",
        "English",
        "Sport",
        "Geography",
        "History",
    ];
    let cars = [CarModel::Audi, CarModel::BMW, CarModel::Chevrolet];

    let input_prompt = Input::new("Enter your name", |s| Ok(s.to_string()))
        .default_value("John")
        .help_message("Please provide your real name");
    let confirmation = Confirmation::new("Do you want a cup of coffee?").default_positive(true);
    let dessert_selection = Selection::new("Your favoite dessert", desserts.into_iter());
    let car_selection =
        Selection::new_with_transformation("Your car model", cars.into_iter(), car_to_string);
    let subjects_selection =
        Multiselect::new("What are your favourite subjects", subjects.into_iter());

    let name = input_prompt.display();
    let is_coffee = confirmation.display();
    let dessert = dessert_selection.display();
    let car = car_selection.display();
    let subjects = subjects_selection.display();

    println!("Name: {:?}", name);
    println!("Is coffee: {:?}", is_coffee);
    println!("Dessert: {:?}", dessert);
    println!("Car: {:?}", car);
    println!("Subjects: {:?}", subjects);
}

pub fn help_message<S: Into<String>>(self, message: S) -> Self

Sets a help message which will be displayed after the input string until the prompt is completed

Examples found in repository

examples/general.rs (line 44)

fn main() {
    let desserts = [
        "Tiramisu",
        "Cheesecake",
        "Brownee",
        "Cookie",
        "Jelly",
        "Chupa-Chups",
        "Pudding",
    ];
    let subjects = [
        "Physics",
        "Math",
        "Polish",
        "English",
        "Sport",
        "Geography",
        "History",
    ];
    let cars = [CarModel::Audi, CarModel::BMW, CarModel::Chevrolet];

    let input_prompt = Input::new("Enter your name", |s| Ok(s.to_string()))
        .default_value("John")
        .help_message("Please provide your real name");
    let confirmation = Confirmation::new("Do you want a cup of coffee?").default_positive(true);
    let dessert_selection = Selection::new("Your favoite dessert", desserts.into_iter());
    let car_selection =
        Selection::new_with_transformation("Your car model", cars.into_iter(), car_to_string);
    let subjects_selection =
        Multiselect::new("What are your favourite subjects", subjects.into_iter());

    let name = input_prompt.display();
    let is_coffee = confirmation.display();
    let dessert = dessert_selection.display();
    let car = car_selection.display();
    let subjects = subjects_selection.display();

    println!("Name: {:?}", name);
    println!("Is coffee: {:?}", is_coffee);
    println!("Dessert: {:?}", dessert);
    println!("Car: {:?}", car);
    println!("Subjects: {:?}", subjects);
}

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

Sets the default value for the prompt. It is cleared once any key is pressed other than Enter.

Examples found in repository

examples/general.rs (line 43)

fn main() {
    let desserts = [
        "Tiramisu",
        "Cheesecake",
        "Brownee",
        "Cookie",
        "Jelly",
        "Chupa-Chups",
        "Pudding",
    ];
    let subjects = [
        "Physics",
        "Math",
        "Polish",
        "English",
        "Sport",
        "Geography",
        "History",
    ];
    let cars = [CarModel::Audi, CarModel::BMW, CarModel::Chevrolet];

    let input_prompt = Input::new("Enter your name", |s| Ok(s.to_string()))
        .default_value("John")
        .help_message("Please provide your real name");
    let confirmation = Confirmation::new("Do you want a cup of coffee?").default_positive(true);
    let dessert_selection = Selection::new("Your favoite dessert", desserts.into_iter());
    let car_selection =
        Selection::new_with_transformation("Your car model", cars.into_iter(), car_to_string);
    let subjects_selection =
        Multiselect::new("What are your favourite subjects", subjects.into_iter());

    let name = input_prompt.display();
    let is_coffee = confirmation.display();
    let dessert = dessert_selection.display();
    let car = car_selection.display();
    let subjects = subjects_selection.display();

    println!("Name: {:?}", name);
    println!("Is coffee: {:?}", is_coffee);
    println!("Dessert: {:?}", dessert);
    println!("Car: {:?}", car);
    println!("Subjects: {:?}", subjects);
}

pub fn style(self, style: InputStyle) -> Self

Sets the style for the prompt

Examples found in repository

examples/styling.rs (lines 31-36)

fn main() -> Result<()> {
    let label_style = LabelStyle::default()
        .prefix("*")
        .prefix_formatting(Formatting::default().foreground_color(Color::Cyan))
        .prompt_formatting(
            Formatting::default()
                .bold()
                .underline()
                .foreground_color(Color::Magenta),
        );
    let input_formatting = Formatting::default().foreground_color(Color::Cyan);
    let submitted_formatting = Formatting::default().foreground_color(Color::DarkCyan);

    let name = Input::new("Enter your name", name_validation)
        .style(
            InputStyle::default()
                .label_style(label_style.clone())
                .input_formatting(input_formatting.clone())
                .submitted_formatting(submitted_formatting.clone()),
        )
        .display();
    let coffee = Confirmation::new("Do you want a cup of coffee")
        .style(
            ConfirmationStyle::default()
                .label_style(label_style.clone())
                .input_formatting(input_formatting.clone())
                .submitted_formatting(submitted_formatting.clone()),
        )
        .display();

    println!("Name: {:?}", name);
    println!("Coffee: {:?}", coffee);

    Ok(())
}

Trait Implementations

impl<T, F> Prompt<T> for Input<F>

where F: Fn(&str) -> Result<T, String>,

fn draw(&self, commands: &mut impl CommandBuffer)

Defines how to draw the prompt with a set of commands. The goal of this method is to populate the commands buffer with a set of commands that will draw your prompt to the screen.

fn on_key_pressed(&mut self, key: Key) -> EventOutcome<T>

This should handle the keyboard key presses. Should return the outcome of the keypress: