Struct demand::MultiSelect

source ·
pub struct MultiSelect<'a, T> {
    pub title: String,
    pub theme: &'a Theme,
    pub description: String,
    pub options: Vec<DemandOption<T>>,
    pub min: usize,
    pub max: usize,
    pub filterable: bool,
    /* private fields */
}
Expand description

Select multiple options from a list

§Example

use demand::{DemandOption, MultiSelect};

let multiselect = MultiSelect::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 = multiselect.run().expect("error running multi select");

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

§options: Vec<DemandOption<T>>

The options which can be selected

§min: usize

The minimum number of options which must be selected

§max: usize

The maximum number of options which can be selected

§filterable: bool

Whether the selector can be filtered with a query

Implementations§

source§

impl<'a, T> MultiSelect<'a, T>

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 option(self, option: DemandOption<T>) -> Self

Add an option to the selector

source

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

Add multiple options to the selector

source

pub fn min(self, min: usize) -> Self

Set the minimum number of options which must be selected

source

pub fn max(self, max: usize) -> Self

Set the maximum number of options which can be selected

source

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

Set whether the selector can be filtered with a query

source

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

Set the theme of the selector

source

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

Displays the selector to the user and returns their selected options

Auto Trait Implementations§

§

impl<'a, T> Freeze for MultiSelect<'a, T>

§

impl<'a, T> RefUnwindSafe for MultiSelect<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for MultiSelect<'a, T>
where T: Send,

§

impl<'a, T> Sync for MultiSelect<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for MultiSelect<'a, T>
where T: Unpin,

§

impl<'a, T> UnwindSafe for MultiSelect<'a, T>
where T: UnwindSafe,

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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.