Struct inquire::Select

pub struct Select<'a> {
    pub message: &'a str,
    pub options: &'a [&'a str],
    pub help_message: Option<&'a str>,
    pub page_size: usize,
    pub vim_mode: bool,
    pub starting_cursor: usize,
    pub filter: Filter<'a>,
    pub formatter: OptionFormatter<'a>,
    pub render_config: &'a RenderConfig,
}

Prompt suitable for when you need the user to select one option among many.

The user can select and submit the current highlighted option by pressing space or enter.

This prompt requires a prompt message and a non-empty list of options to be displayed to the user. If the list is empty, the prompt operation will fail with an InquireError::InvalidConfiguration error.

This prompt does not support custom validators because of its nature. A submission always selects exactly one of the options. If this option was not supposed to be selected or is invalid in some way, it probably should not be included in the options list.

The options are paginated in order to provide a smooth experience to the user, with the default page size being 7. The user can move from the options and the pages will be updated accordingly, including moving from the last to the first options (or vice-versa).

Like all others, this prompt also allows you to customize several aspects of it:

• Prompt message: Required when creating the prompt.
• Options list: Options displayed to the user. Must be non-empty.
• Starting cursor: Index of the cursor when the prompt is first rendered. Default is 0 (first option). If the index is out-of-range of the option list, the prompt will fail with an InquireError::InvalidConfiguration error.
• Help message: Message displayed at the line below the prompt.
• Formatter: Custom formatter in case you need to pre-process the user input before showing it as the final answer.
  • Prints the selected option string value by default.
• Page size: Number of options displayed at once, 7 by default.
• Filter function: Function that defines if an option is displayed or not based on the current filter input.

Example

use inquire::Select;

let options = vec!["Banana", "Apple", "Strawberry", "Grapes",
    "Lemon", "Tangerine", "Watermelon", "Orange", "Pear", "Avocado", "Pineapple",
];

let ans = Select::new("What's your favorite fruit?", &options).prompt();

match ans {
    Ok(choice) => println!("{}! That's mine too!", choice.value),
    Err(_) => println!("There was an error, please try again"),
}

Fields

message: &'a str

Message to be presented to the user.

options: &'a [&'a str]

Options displayed to the user.

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.

formatter: OptionFormatter<'a>

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

render_config: &'a RenderConfig

RenderConfig to apply to the rendered interface.

Implementations

impl<'a> Select<'a>

pub const DEFAULT_FORMATTER: OptionFormatter<'a>

Default formatter, set to DEFAULT_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.

pub const DEFAULT_VIM_MODE: bool

Default value of vim mode.

pub const DEFAULT_STARTING_CURSOR: usize

Default starting cursor index.

pub const DEFAULT_HELP_MESSAGE: Option<&'a str>

Default help message.

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

Creates a Select 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_filter(self, filter: Filter<'a>) -> Self

Sets the filter function.

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

Sets the formatter.

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

Sets the starting cursor index.

pub fn with_render_config(self, render_config: &'a RenderConfig) -> Self

Sets the provided color theme to this prompt.

pub fn prompt(self) -> InquireResult<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 Select<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Select<'a>