Struct Sort 

pub struct Sort<'a, T> {
    pub message: &'a str,
    pub options: Vec<T>,
    pub help_message: Option<&'a str>,
    pub page_size: usize,
    pub vim_mode: bool,
    pub starting_cursor: usize,
    pub formatter: MultiOptionFormatter<'a, T>,
    pub render_config: RenderConfig<'a>,
}

Prompt designed for sorting/re-ordering a list of items.

The user moves the cursor via ↑/↓, presses Space to select/highlight an item, and then moves that item up/down using ↑/↓ or j/k (Vim style) to change its order. Pressing Enter submits the final sorted list.

Example

use inquire::Sort;

let options = vec!["Apple", "Banana", "Cherry"];
let sorted = Sort::new("Order your favorite fruits:", options)
    .prompt()
    .unwrap();

Fields

message: &'a str

Message to be presented to the user.

options: Vec<T>

Options/Items to be sorted.

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.

starting_cursor: usize

Starting cursor index.

formatter: MultiOptionFormatter<'a, T>

Function that formats the sorted list for final display.

render_config: RenderConfig<'a>

RenderConfig to apply to the rendered interface.

Implementations

impl<'a, T> Sort<'a, T>

where T: Display,

pub const DEFAULT_FORMATTER: MultiOptionFormatter<'a, T>

Default formatter: Prints the sorted list joined by commas.

pub const DEFAULT_PAGE_SIZE: usize = crate::config::DEFAULT_PAGE_SIZE

Default page size of the list of options.

pub const DEFAULT_VIM_MODE: bool = crate::config::DEFAULT_VIM_MODE

Default setting for Vim mode (disabled by default).

pub const DEFAULT_STARTING_CURSOR: usize = 0

Default index where the cursor starts.

pub const DEFAULT_HELP_MESSAGE: Option<&'a str>

Help message instructing how to reorder the items.

pub fn new(message: &'a str, options: Vec<T>) -> Self

Creates a Sort prompt with the provided message and options.

pub fn with_help_message(self, message: &'a str) -> Self

Sets the help message to be presented to the user.

pub fn without_help_message(self) -> Self

Removes the help message.

pub fn with_page_size(self, page_size: usize) -> Self

Sets the page size of the options displayed to the user.

pub fn with_vim_mode(self, vim_mode: bool) -> Self

Enables or disables Vim-style keybindings.

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

Sets the starting cursor index.

pub fn with_formatter(self, formatter: MultiOptionFormatter<'a, T>) -> Self

Sets the formatter to customize how the final selected answer is printed.

pub fn with_render_config(self, render_config: RenderConfig<'a>) -> Self

Sets the custom render configuration.

pub fn prompt(self) -> InquireResult<Vec<T>>

Prompts the user and returns the final sorted list of elements.

pub fn prompt_skippable(self) -> InquireResult<Option<Vec<T>>>

Prompts the user and returns the final sorted list of elements, returning None if the operation was canceled.

pub fn raw_prompt_skippable(self) -> InquireResult<Option<Vec<ListOption<T>>>>

Prompts the user and returns the final sorted list of options with original indices, returning None if the operation was canceled.

pub fn raw_prompt(self) -> InquireResult<Vec<ListOption<T>>>

Prompts the user and returns the final sorted list of options, preserving original index details.

Trait Implementations

impl<'a, T: Clone> Clone for Sort<'a, T>

fn clone(&self) -> Sort<'a, T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.