Struct demand::Select

pub struct Select<T: Display> {
    pub title: String,
    pub theme: Theme,
    pub description: String,
    pub options: Vec<DemandOption<T>>,
    pub filterable: bool,
    /* private fields */
}

Select multiple options from a list

Example

use demand::{DemandOption, Select};

let ms = Select::new("Toppings")
  .description("Select your topping")
  .filterable(true)
  .option(DemandOption::new("Lettuce"))
  .option(DemandOption::new("Tomatoes"))
  .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 topping = ms.run().expect("error running multi select");

Fields

title: String

The title of the selector

theme: Theme

The colors/style of the selector

description: String

A description to display above the selector

options: Vec<DemandOption<T>>

The options which can be selected

filterable: bool

Whether the selector can be filtered with a query

Implementations

impl<T: Display> Select<T>

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

Create a new select with the given title

Examples found in repository

examples/select.rs (line 4)

fn main() {
    let ms = Select::new("Toppings")
        .description("Select your toppings")
        .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"));
    ms.run().expect("error running multi select");
}

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

Set the description of the selector

Examples found in repository

examples/select.rs (line 5)

fn main() {
    let ms = Select::new("Toppings")
        .description("Select your toppings")
        .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"));
    ms.run().expect("error running multi select");
}

pub fn option(self, option: DemandOption<T>) -> Self

Add an option to the selector

Examples found in repository

examples/select.rs (line 7)

fn main() {
    let ms = Select::new("Toppings")
        .description("Select your toppings")
        .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"));
    ms.run().expect("error running multi select");
}

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

Set whether the selector can be filtered with a query

Examples found in repository

examples/select.rs (line 6)

fn main() {
    let ms = Select::new("Toppings")
        .description("Select your toppings")
        .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"));
    ms.run().expect("error running multi select");
}

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

Set the theme of the selector

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

Displays the selector to the user and returns their selected options

Examples found in repository

examples/select.rs (line 14)

fn main() {
    let ms = Select::new("Toppings")
        .description("Select your toppings")
        .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"));
    ms.run().expect("error running multi select");
}