Struct inquire::Confirm

pub struct Confirm<'a> {
    pub message: &'a str,
    pub default: Option<bool>,
    pub help_message: Option<&'a str>,
    pub formatter: fn(answer: bool) -> &'a str,
    pub parser: fn(answer: &str) -> Result<bool, String>,
    pub default_value_formatter: fn(answer: bool) -> &'a str,
}

Presents a message to the user and asks them for a yes/no confirmation.

Fields

message: &'a str

Message to be presented to the user.

default: Option<bool>

Default value, returned when the user input is empty.

help_message: Option<&'a str>

Help message to be presented to the user.

formatter: fn(answer: bool) -> &'a str

Function that formats the user input and presents it to the user as the final rendering of the prompt.

parser: fn(answer: &str) -> Result<bool, String>

Function that parses the user input and returns the result

default_value_formatter: fn(answer: bool) -> &'a str

Function that formats the default value to be presented to the user

Implementations

impl<'a> Confirm<'a>

pub const DEFAULT_FORMATTER: fn(answer: bool) -> &'a str

Default formatter, true maps to “Yes” and false maps to “No”.

pub const DEFAULT_PARSER: fn(answer: &str) -> Result<bool, String>

Default parser, matches [“y”] and [“yes”] to true, [“n”] and [“no”] to false, and an Err otherwise.

pub const DEFAULT_DEFAULT_VALUE_FORMATTER: fn(answer: bool) -> &'a str

Default formatter for default values, mapping true to [“Y/n”] and false to [“y/N”]

pub fn new(message: &'a str) -> Self

Creates a Confirm with the provided message and default configuration values.

pub fn with_default(self, default: bool) -> Self

Sets the default input.

pub fn with_help_message(self, message: &'a str) -> Self

Sets the help message of the prompt.

pub fn with_formatter(self, formatter: fn(answer: bool) -> &'a str) -> Self

Sets the formatter

pub fn with_parser(
    self,
    parser: fn(answer: &str) -> Result<bool, String>
) -> Self

Sets the parser

pub fn with_default_value_formatter(
    self,
    formatter: fn(answer: bool) -> &'a str
) -> Self

Sets the default value formatter

pub fn prompt(self) -> InquireResult<bool>

Parses the provided behavioral and rendering options and prompts the CLI user for input according to them.

Trait Implementations

impl<'a> Clone for Confirm<'a>

fn clone(&self) -> Confirm<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> From<&'a str> for Confirm<'a>

fn from(val: &'a str) -> Self

Performs the conversion.

impl<'a> Copy for Confirm<'a>