Struct dialoguer::FuzzySelect

source · [−]

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

Expand description

Renders a selection menu that user can fuzzy match to reduce set.

User can use fuzzy search to limit selectable items. Interaction returns index of an item selected in the order they appear in item invocation or items slice.

Examples

use dialoguer::{
    FuzzySelect,
    theme::ColorfulTheme
};
use console::Term;

fn main() -> std::io::Result<()> {
    let items = vec!["Item 1", "item 2"];
    let selection = FuzzySelect::with_theme(&ColorfulTheme::default())
        .items(&items)
        .default(0)
        .interact_on_opt(&Term::stderr())?;

    match selection {
        Some(index) => println!("User selected item : {}", items[index]),
        None => println!("User did not select anything")
    }

    Ok(())
}

Implementations

source

impl FuzzySelect<'static>

source

pub fn new() -> Self

Creates the prompt with a specific text.

source

impl FuzzySelect<'_>

source

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

Sets the clear behavior of the menu.

The default is to clear the menu.

source

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

Sets a default for the menu

source

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

Add a single item to the fuzzy selector.

source

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

Adds multiple items to the fuzzy selector.

source

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

Prefaces the menu with a prompt.

When a prompt is set the system also prints out a confirmation after the fuzzy selection.

source

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

Indicates whether to report the selected value after interaction.

The default is to report the selection.

source

pub fn highlight_matches(&mut self, val: bool) -> &mut Self

Indicates whether to highlight matched indices

The default is to highlight the indices

source

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

Enables user interaction and returns the result.

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

source

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

Enables user interaction and returns the result.

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

source