Struct Confirmation 

pub struct Confirmation { /* private fields */ }

A prompt that expects a “yes or no” answer. You can press ‘y’ or ‘n’ for positive or negative result. Pressing ‘Enter’ without any previous input will trigger the default ansewer, which is configurable

use cli_prompts::{
    prompts::{Confirmation, AbortReason},
    style::{ConfirmationStyle, Formatting},
    DisplayPrompt,
};

fn main() {
    let prompt = Confirmation::new("Are you sure you want to delete this file?")
                    .default_positive(false)
                    .style(ConfirmationStyle::default());
    let answer : Result<bool, AbortReason> = prompt.display();
    match answer {
        Ok(is_positive) => println!("The answer is {}", is_positive),
        Err(abort_reason) => println!("The prompt was aborted because of {:?}", abort_reason),
    }
}

Implementations

impl Confirmation

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

Constructs a new prompt with a given label

Examples found in repository

examples/styling.rs (line 38)

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 45)

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_positive(self, default_positive: bool) -> Self

Sets whether the default value is positive or negative

Examples found in repository

examples/general.rs (line 45)

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, s: ConfirmationStyle) -> Self

Sets the style of the prompt

Examples found in repository

examples/styling.rs (lines 39-44)

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 Prompt<bool> for Confirmation

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<bool>

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