Struct Dialog

pub struct Dialog<'a> {
    pub title: String,
    pub theme: &'a Theme,
    pub description: String,
    pub buttons: Vec<DialogButton>,
    /* private fields */
}

A dialog to display to the user

Example

use demand::Dialog;
use demand::DialogButton;

let dialog = Dialog::new("Are you sure?")
  .description("This will do a thing.")
  .buttons(vec![
     DialogButton::new("Ok"),
     DialogButton::new("Not sure"),
     DialogButton::new("Cancel"),
  ]);
let choice = match dialog.run() {
  Ok(value) => value,
  Err(e) => {
      if (e.kind() == std::io::ErrorKind::Interrupted) {
          println!("Dialog cancelled");
          return;
      } 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

buttons: Vec<DialogButton>

The buttons to display to the user

Implementations

impl<'a> Dialog<'a>

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

Create a new dialog with the given title

By default, the dialog will have a single “Ok” button and a “Cancel” button.

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

Set the description of the dialog

pub fn buttons(self, buttons: Vec<DialogButton>) -> Self

Set the buttons of the dialog

pub fn selected_button(self, idx: usize) -> Self

Set the index of the initially selected button.

The idx is the index of the button in the buttons vector and is 0-indexed.

Errors

This will panic if there are no buttons to select or if the index is out of bounds.

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

Set the theme of the dialog

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

Displays the dialog to the user and returns their response.

The response will be the label of the selected button.

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.