Struct may_clack::confirm::Confirm

pub struct Confirm<M: Display> { /* private fields */ }

Confirm struct.

Examples

use may_clack::confirm;

let answer = confirm("message")
    .initial_value(true)
    .prompts("true", "false")
    .interact()?;
println!("answer {:?}", answer);

Implementations

impl<M: Display> Confirm<M>

pub fn new(message: M) -> Confirm<M>

Creates a new Confirm struct.

Has a shorthand in confirm().

Examples

use may_clack::{confirm, confirm::Confirm};

// these two are equivalent
let question = Confirm::new("message");
let question = confirm("message");

pub fn initial_value(&mut self, b: bool) -> &mut Self

Specify the initial value.

Default: false

Examples

use may_clack::confirm;

let answer = confirm("message").initial_value(true).interact()?;
println!("answer {:?}", answer);

pub fn prompts<S: ToString>(&mut self, yes: S, no: S) -> &mut Self

Specify the prompts to display for true and false.

Default: "yes", "no".

Examples

use may_clack::confirm;

let answer = confirm("message").prompts("true", "false").interact()?;
println!("answer {:?}", answer);

Examples found in repository

examples/full.rs (line 22)

fn main() -> Result<(), ClackError> {
	println!();
	intro!(" full ".reversed());

	info!("visit the documentation at https://docs.rs/may-clack");

	let do_input = input("input")
		.placeholder("placeholder")
		.cancel(do_cancel)
		.required()?;
	let do_multi_input = multi_input("multi input")
		.max(4)
		.cancel(do_cancel)
		.interact()?;
	let do_confirm = confirm("confirm")
		.prompts("true", "false")
		.cancel(do_cancel)
		.interact()?;
	let do_multi_select = multi_select("multi select")
		.option("opt1", "option 1")
		.option("opt2", "option 2")
		.option_hint("opt3", "option 3", "hint")
		.cancel(do_cancel)
		.interact()?;
	let do_select = select("select")
		.option("val1", "value 1")
		.option("val2", "value 2")
		.option_hint("val 3", "value 3", "hint")
		.cancel(do_cancel)
		.interact()?;

	outro!();

	println!("input {:?}", do_input);
	println!("confirm {:?}", do_confirm);
	println!("multi_input {:?}", do_multi_input);
	println!("multi_select {:?}", do_multi_select);
	println!("select {:?}", do_select);

	Ok(())
}

pub fn cancel<F>(&mut self, cancel: F) -> &mut Self

where F: Fn() + 'static,

Specify function to call on cancel.

Examples

use may_clack::{confirm, cancel};

let answer = confirm("message").cancel(do_cancel).interact()?;
println!("answer {:?}", answer);

fn do_cancel() {
    cancel!("operation cancelled");
    panic!("operation cancelled");
}

Examples found in repository

examples/generic.rs (line 8)

fn main() -> Result<(), ClackError> {
	println!();
	intro!(" generic messages ".reversed());

	let number = confirm(20).cancel(do_cancel).interact()?;
	let styled = multi_input("style".on_cyan())
		.cancel(do_cancel)
		.interact()?;

	outro!();

	println!("number {:?}", number);
	println!("styled {:?}", styled);

	Ok(())
}

examples/full.rs (line 23)

fn main() -> Result<(), ClackError> {
	println!();
	intro!(" full ".reversed());

	info!("visit the documentation at https://docs.rs/may-clack");

	let do_input = input("input")
		.placeholder("placeholder")
		.cancel(do_cancel)
		.required()?;
	let do_multi_input = multi_input("multi input")
		.max(4)
		.cancel(do_cancel)
		.interact()?;
	let do_confirm = confirm("confirm")
		.prompts("true", "false")
		.cancel(do_cancel)
		.interact()?;
	let do_multi_select = multi_select("multi select")
		.option("opt1", "option 1")
		.option("opt2", "option 2")
		.option_hint("opt3", "option 3", "hint")
		.cancel(do_cancel)
		.interact()?;
	let do_select = select("select")
		.option("val1", "value 1")
		.option("val2", "value 2")
		.option_hint("val 3", "value 3", "hint")
		.cancel(do_cancel)
		.interact()?;

	outro!();

	println!("input {:?}", do_input);
	println!("confirm {:?}", do_confirm);
	println!("multi_input {:?}", do_multi_input);
	println!("multi_select {:?}", do_multi_select);
	println!("select {:?}", do_select);

	Ok(())
}

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

Wait for the user to submit an answer.

Examples

use may_clack::confirm;

let answer = confirm("message")
    .initial_value(true)
    .prompts("true", "false")
    .interact()?;
println!("answer {:?}", answer);

Examples found in repository

examples/generic.rs (line 8)

fn main() -> Result<(), ClackError> {
	println!();
	intro!(" generic messages ".reversed());

	let number = confirm(20).cancel(do_cancel).interact()?;
	let styled = multi_input("style".on_cyan())
		.cancel(do_cancel)
		.interact()?;

	outro!();

	println!("number {:?}", number);
	println!("styled {:?}", styled);

	Ok(())
}

examples/full.rs (line 24)

fn main() -> Result<(), ClackError> {
	println!();
	intro!(" full ".reversed());

	info!("visit the documentation at https://docs.rs/may-clack");

	let do_input = input("input")
		.placeholder("placeholder")
		.cancel(do_cancel)
		.required()?;
	let do_multi_input = multi_input("multi input")
		.max(4)
		.cancel(do_cancel)
		.interact()?;
	let do_confirm = confirm("confirm")
		.prompts("true", "false")
		.cancel(do_cancel)
		.interact()?;
	let do_multi_select = multi_select("multi select")
		.option("opt1", "option 1")
		.option("opt2", "option 2")
		.option_hint("opt3", "option 3", "hint")
		.cancel(do_cancel)
		.interact()?;
	let do_select = select("select")
		.option("val1", "value 1")
		.option("val2", "value 2")
		.option_hint("val 3", "value 3", "hint")
		.cancel(do_cancel)
		.interact()?;

	outro!();

	println!("input {:?}", do_input);
	println!("confirm {:?}", do_confirm);
	println!("multi_input {:?}", do_multi_input);
	println!("multi_select {:?}", do_multi_select);
	println!("select {:?}", do_select);

	Ok(())
}