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,
    pub keep_filter: bool,
    pub formatter: fn(answer: &[OptionAnswer]) -> String,
    pub validator: Option<MultiOptionValidator<'a>>,
}

Presents a message to the user and a list of options for the user to choose from. The user is able to choose multiple options.

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

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: fn(answer: &[OptionAnswer]) -> String

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.

Implementations

impl<'a> MultiSelect<'a>

pub const DEFAULT_FORMATTER: fn(answer: &[OptionAnswer]) -> String

Default formatter that maps the collection of options to their string values and joins them using a comma as the separator.

pub const DEFAULT_FILTER: Filter

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 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) -> Self

Sets the filter function.

pub fn with_formatter(
    self,
    formatter: fn(answer: &[OptionAnswer]) -> String
) -> Self

Sets the formatter.

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

Adds a validator to the collection of validators.

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 them.

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>