Struct FuzzySelect

Source

pub struct FuzzySelect { /* private fields */ }

Expand description

An inline fuzzy-select prompt.

§Examples

use sparcli::{FuzzySelect, Outcome};

if let Outcome::Submitted(index) =
    FuzzySelect::new("Find a fruit:").options(["apple", "banana"]).run()?
{
    println!("chose option {index}");
}

Implementations§

Source §

impl FuzzySelect

Source

pub fn new(prompt: impl Into<String>) -> Self

Creates a fuzzy prompt with the given label.

Examples found in repository ?

examples/prompts.rs (line 102)

101fn pick_fruit() -> sparcli::Result<Outcome<usize>> {
102    FuzzySelect::new("Find a fruit:")
103        .options(["apple", "apricot", "banana", "cherry", "grape"])
104        .run()
105}

Source

pub fn query(self, query: impl Into<String>) -> Self

Pre-fills the search query.

Source

pub fn shortcuts(self, shortcuts: I) -> Self
where I: IntoIterator<Item = Shortcut>,

Registers shortcuts shown in a footer hint.

Pressing a bound key ends the prompt with Outcome::Shortcut. Use modified keys (e.g. Ctrl-…) so they do not collide with typing.

Source

pub fn options<I, S>(self, options: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Adds options from any string iterator.

Examples found in repository ?

examples/prompts.rs (line 103)

101fn pick_fruit() -> sparcli::Result<Outcome<usize>> {
102    FuzzySelect::new("Find a fruit:")
103        .options(["apple", "apricot", "banana", "cherry", "grape"])
104        .run()
105}

Source

pub fn multi(self) -> Self

Enables multi-selection with checkboxes.

Source

pub fn max_visible(self, rows: usize) -> Self

Sets the maximum number of visible result rows.

Source

pub fn run(self) -> Result<Outcome<usize>>

Runs a single-select fuzzy prompt, returning the chosen index.

§Errors

Returns SparcliError::NoTerminal without an interactive terminal, or SparcliError::Io on a terminal failure.

Examples found in repository ?

examples/prompts.rs (line 104)

101fn pick_fruit() -> sparcli::Result<Outcome<usize>> {
102    FuzzySelect::new("Find a fruit:")
103        .options(["apple", "apricot", "banana", "cherry", "grape"])
104        .run()
105}