Struct List

pub struct List<'a> {
    pub title: String,
    pub description: String,
    pub success_items: usize,
    pub theme: &'a Theme,
    /* private fields */
}

Display a list of options

Example

use demand::{DmandOption, List};

let list = List::new("Toppings")
  .description("Select your toppings")
  .min(1)
  .max(4)
  .filterable(true)
  .option(DemandOption::new("Lettuce").selected(true))
  .option(DemandOption::new("Tomatoes").selected(true))
  .option(DemandOption::new("Charm Sauce"))
  .option(DemandOption::new("Jalapenos").label("Jalapeños"))
  .option(DemandOption::new("Cheese"))
  .option(DemandOption::new("Vegan Cheese"))
  .option(DemandOption::new("Nutella"));
let toppings = match list.run() {
  Ok(_) => {},
  Err(e) => {
      if e.kind() == std::io::ErrorKind::Interrupted {
          println!("Input cancelled");
          return;
      } else {
          panic!("Error: {}", e);
      }
  }
};

Fields

title: String

Title of the list

description: String

Description of the list

success_items: usize

Number of items to show on each page

theme: &'a Theme

Colors/style of the input

Implementations

impl<'a> List<'a>

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

Creates a new list with a title

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

Sets the description of the list

pub fn item(self, entry: &'a str) -> Self

Adds an item to the list

pub fn items(self, entries: &[&'a str]) -> Self

Adds multiple items to the list

pub fn success_items(self, items: usize) -> Self

Sets the number of items to show on confirmation

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

Sets the list to be filterable

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

Sets the theme of the list

pub fn run(self) -> Result<(), Error>

Displays the input to the user and returns the 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.