demand

Struct Confirm

Source
pub struct Confirm<'a> {
    pub title: String,
    pub theme: &'a Theme,
    pub description: String,
    pub affirmative: String,
    pub negative: String,
    pub selected: bool,
    /* private fields */
}
Expand description

Select multiple options from a list

§Example

use demand::Confirm;

let confirm = Confirm::new("Are you sure?")
  .affirmative("Yes!")
  .negative("No.");
let choice = match confirm.run() {
    Ok(confirm) => confirm,
    Err(e) => {
        if e.kind() == std::io::ErrorKind::Interrupted {
            println!("Dialog cancelled");
            false
        } else {
            panic!("Error: {}", e);
        }
    }
};

Fields§

§title: String

The title of the selector

§theme: &'a Theme

The colors/style of the selector

§description: String

A description to display above the selector

§affirmative: String

The text to display for the affirmative option

§negative: String

The text to display for the negative option

§selected: bool

If true, the affirmative option is selected by default

Implementations§

Source§

impl<'a> Confirm<'a>

Source

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

Create a new multi select with the given title

Source

pub fn description(self, description: &str) -> Self

Set the description of the selector

Source

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

Set the label of the affirmative option

Source

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

Set the label of the negative option

Source

pub fn selected(self, selected: bool) -> Self

Set whether the affirmative option is selected by default

Source

pub fn theme(self, theme: &'a Theme) -> Self

Set the theme of the dialog

Source

pub fn run(self) -> Result<bool>

Displays the dialog to the user and returns their response

This function will block until the user submits the input. If the user cancels the input, an error of type io::ErrorKind::Interrupted is returned.

Auto Trait Implementations§

§

impl<'a> Freeze for Confirm<'a>

§

impl<'a> RefUnwindSafe for Confirm<'a>

§

impl<'a> Send for Confirm<'a>

§

impl<'a> Sync for Confirm<'a>

§

impl<'a> Unpin for Confirm<'a>

§

impl<'a> UnwindSafe for Confirm<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.