Struct dialoguer::Confirmation

pub struct Confirmation<'a> { /* fields omitted */ }

Renders a simple confirmation prompt.

Example usage

use dialoguer::Confirmation;

if Confirmation::new().with_text("Do you want to continue?").interact()? {
    println!("Looks like you want to continue");
} else {
    println!("nevermind then :(");
}

Methods

impl<'a> Confirmation<'a>

pub fn new() -> Confirmation<'static>

Creates the prompt with a specific text.

pub fn with_theme(theme: &'a dyn Theme) -> Confirmation<'a>

Sets a theme other than the default one.

pub fn with_text(&mut self, text: &str) -> &mut Confirmation<'a>

Sets the confirmation text.

pub fn default(&mut self, val: bool) -> &mut Confirmation<'a>

Overrides the default.

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

Disables or enables the default value display.

The default is to append [y/n] to the prompt to tell the user which keys to press. This also renders the default choice in uppercase. The default is selected on enter.

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

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

Like interact but allows a specific terminal to be set.