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,
    pub formatter: fn(answer: &OptionAnswer) -> String,
}

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

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

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

formatter: fn(answer: &OptionAnswer) -> String

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

Implementations

impl<'a> Select<'a>

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

Default formatter.

pub const DEFAULT_FILTER: Filter

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

Sets the filter function.

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

Sets the formatter.

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

Sets the starting cursor index.

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

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

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>