Struct inquire::MultiSelect

pub struct MultiSelect<'a> {
    pub message: &'a str,
    pub options: &'a [&'a str],
    pub default: Option<&'a [usize]>,
    pub help_message: Option<&'a str>,
    pub page_size: usize,
    pub vim_mode: bool,
    pub starting_cursor: usize,
    pub filter: Filter<'a>,
    pub keep_filter: bool,
    pub formatter: MultiOptionFormatter<'a>,
    pub validator: Option<MultiOptionValidator<'a>>,
}

Selection of any amount of options from an interactive list.

Fields

message: &'a str

Message to be presented to the user.

options: &'a [&'a str]

Options displayed to the user.

default: Option<&'a [usize]>

Default indexes of options to be selected from the start.

help_message: Option<&'a str>

Help message to be presented to the user.

page_size: usize

Page size of the options displayed to the user.

vim_mode: bool

Whether vim mode is enabled. When enabled, the user can navigate through the options using hjkl.

starting_cursor: usize

Starting cursor index of the selection.

filter: Filter<'a>

Function called with the current user input to filter the provided options.

keep_filter: bool

Whether the current filter typed by the user is kept or cleaned after a selection is made.

formatter: MultiOptionFormatter<'a>

Function that formats the user input and presents it to the user as the final rendering of the prompt.

validator: Option<MultiOptionValidator<'a>>

Validator to apply to the user input.

In case of error, the message is displayed one line above the prompt.

Implementations

impl<'a> MultiSelect<'a>

pub const DEFAULT_FORMATTER: MultiOptionFormatter<'a>

Default formatter, set to DEFAULT_MULTI_OPTION_FORMATTER

pub const DEFAULT_FILTER: Filter<'a>

Default filter, equal to the global default filter config::DEFAULT_FILTER.

pub const DEFAULT_PAGE_SIZE: usize

Default page size, equal to the global default page size config::DEFAULT_PAGE_SIZE

pub const DEFAULT_VIM_MODE: bool

Default value of vim mode, equal to the global default value config::DEFAULT_PAGE_SIZE

pub const DEFAULT_STARTING_CURSOR: usize

Default starting cursor index.

pub const DEFAULT_KEEP_FILTER: bool

Default behavior of keeping or cleaning the current filter value.

pub const DEFAULT_HELP_MESSAGE: Option<&'a str>

Default help message.

pub const DEFAULT_VALIDATOR: Option<MultiOptionValidator<'a>>

Default validator set for the MultiSelect prompt, none.

pub fn new(message: &'a str, options: &'a [&str]) -> Self

Creates a MultiSelect with the provided message and options, along with default configuration values.

pub fn with_help_message(self, message: &'a str) -> Self

Sets the help message of the prompt.

pub fn without_help_message(self) -> Self

Removes the set help message.

pub fn with_page_size(self, page_size: usize) -> Self

Sets the page size.

pub fn with_vim_mode(self, vim_mode: bool) -> Self

Enables or disabled vim_mode.

pub fn with_keep_filter(self, keep_filter: bool) -> Self

Sets the keep filter behavior.

pub fn with_filter(self, filter: Filter<'a>) -> Self

Sets the filter function.

pub fn with_formatter(self, formatter: MultiOptionFormatter<'a>) -> Self

Sets the formatter.

pub fn with_validator(self, validator: MultiOptionValidator<'a>) -> Self

Sets the validator to apply to the user input. You might want to use this feature in case you need to limit the user to specific choices, such as limiting the number of selections.

In case of error, the message is displayed one line above the prompt.

pub fn with_default(self, default: &'a [usize]) -> Self

Sets the indexes to be selected by the default.

pub fn with_starting_cursor(self, starting_cursor: usize) -> Self

Sets the starting cursor index.

pub fn prompt(self) -> InquireResult<Vec<OptionAnswer>>

Parses the provided behavioral and rendering options and prompts the CLI user for input according to the defined rules.

Trait Implementations

impl<'a> Clone for MultiSelect<'a>

fn clone(&self) -> MultiSelect<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for MultiSelect<'a>