Struct dialoguer::Select

pub struct Select<'a> { /* private fields */ }

Renders a select prompt.

User can select from one or more options. Interaction returns index of an item selected in the order they appear in item invocation or items slice.

Example

use dialoguer::Select;

fn main() {
    let items = vec!["foo", "bar", "baz"];

    let selection = Select::new()
        .with_prompt("What do you choose?")
        .items(&items)
        .interact()
        .unwrap();

    println!("You chose: {}", items[selection]);
}

Implementations

impl Select<'static>

pub fn new() -> Self

Creates a select prompt with default theme.

impl Select<'_>

pub fn clear(self, val: bool) -> Self

Indicates whether select menu should be erased from the screen after interaction.

The default is to clear the menu.

pub fn default(self, val: usize) -> Self

Sets initial selected element when select menu is rendered

Element is indicated by the index at which it appears in item method invocation or items slice.

pub fn max_length(self, val: usize) -> Self

Sets an optional max length for a page.

Max length is disabled by None

pub fn item<T: ToString>(self, item: T) -> Self

Add a single item to the selector.

Example

use dialoguer::Select;

fn main() {
    let selection = Select::new()
        .item("Item 1")
        .item("Item 2")
        .interact()
        .unwrap();
}

pub fn items<T: ToString>(self, items: &[T]) -> Self

Adds multiple items to the selector.

pub fn with_prompt<S: Into<String>>(self, prompt: S) -> Self

Sets the select prompt.

By default, when a prompt is set the system also prints out a confirmation after the selection. You can opt-out of this with report.

pub fn report(self, val: bool) -> Self

Indicates whether to report the selected value after interaction.

The default is to report the selection.

pub fn interact(self) -> Result<usize>

Enables user interaction and returns the result.

The user can select the items with the ‘Space’ bar or ‘Enter’ and the index of selected item will be returned. The dialog is rendered on stderr. Result contains index if user selected one of items using ‘Enter’. This unlike interact_opt does not allow to quit with ‘Esc’ or ‘q’.

pub fn interact_opt(self) -> Result<Option<usize>>

Enables user interaction and returns the result.

The user can select the items with the ‘Space’ bar or ‘Enter’ and the index of selected item will be returned. The dialog is rendered on stderr. Result contains Some(index) if user selected one of items using ‘Enter’ or None if user cancelled with ‘Esc’ or ‘q’.

Example

 use dialoguer::Select;

 fn main() {
     let items = vec!["foo", "bar", "baz"];

     let selection = Select::new()
         .with_prompt("What do you choose?")
         .items(&items)
         .interact_opt()
         .unwrap();

     match selection {
         Some(index) => println!("You chose: {}", items[index]),
         None => println!("You did not choose anything.")
     }
 }

pub fn interact_on(self, term: &Term) -> Result<usize>

Like interact but allows a specific terminal to be set.

pub fn interact_on_opt(self, term: &Term) -> Result<Option<usize>>

Like interact_opt but allows a specific terminal to be set.

impl<'a> Select<'a>

pub fn with_theme(theme: &'a dyn Theme) -> Self

Creates a select prompt with a specific theme.

Example

use dialoguer::{theme::ColorfulTheme, Select};

fn main() {
    let selection = Select::with_theme(&ColorfulTheme::default())
        .items(&["foo", "bar", "baz"])
        .interact()
        .unwrap();
}

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 Default for Select<'static>

fn default() -> Self

Returns the “default value” for a type.