Struct dialoguer::OrderList

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

Renders a list to order.

Methods

impl<'a> OrderList<'a>

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

Creates a new orderlist object.

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

Sets a theme other than the default one.

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

Enables or disables paging

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

Sets the clear behavior of the checkbox menu.

The default is to clear the checkbox menu.

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

Add a single item to the selector.

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

Adds multiple items to the selector.

pub fn with_prompt(&mut self, prompt: &str) -> &mut OrderList<'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<Vec<usize>>

Enables user interaction and returns the result.

The user can order the items with the space bar and the arrows. On enter the ordered list will be returned.

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

Like interact but allows a specific terminal to be set.

Trait Implementations

impl<'a> Default for OrderList<'a>

fn default() -> OrderList<'a>

Returns the "default value" for a type.