Struct dialoguer::Select

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

Renders a selection menu.

Methods

impl<'a> Select<'a>

pub fn new() -> Select<'static>

Creates the prompt with a specific text.

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

Same as new but with a specific theme.

pub fn paged(&mut self, val: bool) -> &mut Select<'a>

Enables or disables paging

pub fn clear(&mut self, val: bool) -> &mut Select<'a>

Sets the clear behavior of the menu.

The default is to clear the menu.

pub fn default(&mut self, val: usize) -> &mut Select<'a>

Sets a default for the menu

pub fn item(&mut self, item: &str) -> &mut Select<'a>

Add a single item to the selector.

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

Adds multiple items to the selector.

pub fn with_prompt(&mut self, prompt: &str) -> &mut Select<'a>

Prefaces the menu with a prompt.

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

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

Enables user interaction and returns the result.

The index of the selected item. The dialog is rendered on stderr.

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

Enables user interaction and returns the result.

The index of the selected item. None if the user cancelled with Esc or 'q'. The dialog is rendered on stderr.

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 but allows a specific terminal to be set.