Struct FuzzySelect

pub struct FuzzySelect<T> { /* private fields */ }

A fuzzy select prompt. See the module level documentation for more information.

Implementations

impl<T> FuzzySelect<T>

pub fn new() -> Self

Examples found in repository

examples/demo.rs (line 8)

fn main() {
    let items = vec!["Hello there", "General Kenobi", "You are a bold one"];

    let item = FuzzySelect::new()
        .with_prompt("Select your destiny:")
        .with_options(items)
        .with_query("o")
        .with_initial_selection(2)
        .select()
        .expect("Failed to create FuzzySelect");

    println!("You have chosen: {item:?}");
}

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

Examples found in repository

examples/demo.rs (line 9)

fn main() {
    let items = vec!["Hello there", "General Kenobi", "You are a bold one"];

    let item = FuzzySelect::new()
        .with_prompt("Select your destiny:")
        .with_options(items)
        .with_query("o")
        .with_initial_selection(2)
        .select()
        .expect("Failed to create FuzzySelect");

    println!("You have chosen: {item:?}");
}

pub fn without_prompt(self) -> Self

pub fn set_prompt<P: Into<String>>(self, prompt: impl Into<Option<P>>) -> Self

pub fn with_options(self, options: Vec<T>) -> Self

Examples found in repository

examples/demo.rs (line 10)

fn main() {
    let items = vec!["Hello there", "General Kenobi", "You are a bold one"];

    let item = FuzzySelect::new()
        .with_prompt("Select your destiny:")
        .with_options(items)
        .with_query("o")
        .with_initial_selection(2)
        .select()
        .expect("Failed to create FuzzySelect");

    println!("You have chosen: {item:?}");
}

pub fn with_options_from_iter( self, options: impl IntoIterator<Item = T>, ) -> Self

pub fn with_options_from_slice(self, options: &[T]) -> Self

where T: Clone,

pub fn add_option(self, option: T) -> Self

pub fn add_options(self, options: impl IntoIterator<Item = T>) -> Self

pub fn with_initial_selection(self, initial_selection: u32) -> Self

Examples found in repository

examples/demo.rs (line 12)

fn main() {
    let items = vec!["Hello there", "General Kenobi", "You are a bold one"];

    let item = FuzzySelect::new()
        .with_prompt("Select your destiny:")
        .with_options(items)
        .with_query("o")
        .with_initial_selection(2)
        .select()
        .expect("Failed to create FuzzySelect");

    println!("You have chosen: {item:?}");
}

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

Examples found in repository

examples/demo.rs (line 11)

fn main() {
    let items = vec!["Hello there", "General Kenobi", "You are a bold one"];

    let item = FuzzySelect::new()
        .with_prompt("Select your destiny:")
        .with_options(items)
        .with_query("o")
        .with_initial_selection(2)
        .select()
        .expect("Failed to create FuzzySelect");

    println!("You have chosen: {item:?}");
}

pub fn without_query(self) -> Self

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

pub fn with_filter(self) -> Self

pub fn without_filter(self) -> Self

pub fn set_filter(self, filter: bool) -> Self

pub fn with_select1(self) -> Self

pub fn without_select1(self) -> Self

pub fn set_select1(self, select1: bool) -> Self

pub fn without_highlight(self) -> Self

pub fn set_highlight(self, highlight: bool) -> Self

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

pub fn with_default_page_size(self) -> Self

pub fn with_color(self, color: bool) -> Self

pub fn with_default_color(self) -> Self

pub fn set_color(self, color: impl Into<Option<bool>>) -> Self

pub fn with_theme(self, theme: Theme) -> Self

pub fn with_default_theme(self) -> Self

pub fn without_alternate_screen(self) -> Self

pub fn with_alternate_screen(self) -> Self

pub fn set_alternate_screen(self, alternate_screen: bool) -> Self

pub fn select(self) -> Result<T>

where T: Select,

Runs the fuzzy select prompt and returns the selected item.

Errors

• Error::NoOptions if there are no options to select from. Need to call one of the *option* methods before calling this.
• Error::Cancelled if the user cancelled the selection (e.g. by hitting Ctrl-C or Esc).
• Error::InvalidSelection if the default selection index is out of bounds based off the provided options.
• Error::NonInteractive if the terminal is not in interactive mode. This is the case if the terminal is not a tty.
• Error::IoError if there was an error interacting with interacting with terminal in general.

Examples found in repository

examples/demo.rs (line 13)

fn main() {
    let items = vec!["Hello there", "General Kenobi", "You are a bold one"];

    let item = FuzzySelect::new()
        .with_prompt("Select your destiny:")
        .with_options(items)
        .with_query("o")
        .with_initial_selection(2)
        .select()
        .expect("Failed to create FuzzySelect");

    println!("You have chosen: {item:?}");
}

pub fn select_opt(self) -> Result<Option<T>>

where T: Select,

Runs the fuzzy select prompt and returns the selected item or None if no selection was made.

Errors

• Error::NonInteractive if the terminal is not in interactive mode. This is the case if the terminal is not a tty.
• Error::IoError if there was an error interacting with interacting with terminal in general.

Trait Implementations

impl<T: Clone> Clone for FuzzySelect<T>

fn clone(&self) -> FuzzySelect<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for FuzzySelect<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Default for FuzzySelect<T>

fn default() -> Self

Returns the “default value” for a type.