Struct PickerTui 

pub struct PickerTui {
    pub default_query: String,
    pub header: Option<String>,
    pub auto_accept: bool,
}

Fields

default_query: String

The default value of the query text area

header: Option<String>

The header text to indicate to the user what is being chosen

auto_accept: bool

If there is zero or one options, automatically accept the choice

Implementations

impl PickerTui

pub fn new() -> Self

Examples found in repository

examples/pick_a_noun.rs (line 5)

pub fn main() -> eyre::Result<()> {
    let nouns = vec!["dog", "cat", "house", "pickle", "mouse"];
    let chosen = PickerTui::new().set_header("Pick a noun").pick_one(nouns)?;
    println!("You chose {}", chosen);

    Ok(())
}

examples/pick_many_nouns.rs (line 5)

pub fn main() -> eyre::Result<()> {
    let nouns = vec!["dog", "cat", "house", "pickle", "mouse"];
    let chosen = PickerTui::new()
        .set_header("Press tab to select entries")
        .pick_many(nouns)?;

    println!("You chose {:?}", chosen);

    Ok(())
}

examples/starting_search.rs (line 5)

pub fn main() -> eyre::Result<()> {
    let nouns = vec!["dog", "cat", "house", "pickle", "mouse"];
    let chosen = PickerTui::new()
        .set_header("Pick a noun")
        .set_query("ouse")
        .pick_one(nouns)?;
    println!("You chose {}", chosen);

    Ok(())
}

examples/multiline.rs (line 11)

pub fn main() -> eyre::Result<()> {
    let choices = vec![
        "First\nSecond\nThird",
        "A\nB\nC",
        "IMPORT BRUH\nDO THING\nWOOHOO!",
        "single item",
        "another single item",
    ];
    let chosen = PickerTui::new().pick_many(choices)?;
    println!("You chose: {chosen:#?}");
    Ok(())
}

examples/pick_a_path.rs (line 12)

pub fn main() -> eyre::Result<()> {
    let mut choices = Vec::new();
    let dir = std::fs::read_dir(".")?;
    for entry in dir {
        let entry = entry?;
        choices.push(entry);
    }

    let chosen = PickerTui::new()
        .set_header("Pick a path")
        .pick_one(choices.into_iter().map(|entry| Choice {
            key: entry.path().display().to_string(), // the value shown to the user
            value: entry, // the inner value we want to have after the user picks
        }))?;

    println!("You chose {}", chosen.file_name().to_string_lossy());

    Ok(())
}

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

Examples found in repository

examples/pick_a_noun.rs (line 5)

pub fn main() -> eyre::Result<()> {
    let nouns = vec!["dog", "cat", "house", "pickle", "mouse"];
    let chosen = PickerTui::new().set_header("Pick a noun").pick_one(nouns)?;
    println!("You chose {}", chosen);

    Ok(())
}

examples/pick_many_nouns.rs (line 6)

pub fn main() -> eyre::Result<()> {
    let nouns = vec!["dog", "cat", "house", "pickle", "mouse"];
    let chosen = PickerTui::new()
        .set_header("Press tab to select entries")
        .pick_many(nouns)?;

    println!("You chose {:?}", chosen);

    Ok(())
}

examples/starting_search.rs (line 6)

pub fn main() -> eyre::Result<()> {
    let nouns = vec!["dog", "cat", "house", "pickle", "mouse"];
    let chosen = PickerTui::new()
        .set_header("Pick a noun")
        .set_query("ouse")
        .pick_one(nouns)?;
    println!("You chose {}", chosen);

    Ok(())
}

examples/pick_a_path.rs (line 13)

pub fn main() -> eyre::Result<()> {
    let mut choices = Vec::new();
    let dir = std::fs::read_dir(".")?;
    for entry in dir {
        let entry = entry?;
        choices.push(entry);
    }

    let chosen = PickerTui::new()
        .set_header("Pick a path")
        .pick_one(choices.into_iter().map(|entry| Choice {
            key: entry.path().display().to_string(), // the value shown to the user
            value: entry, // the inner value we want to have after the user picks
        }))?;

    println!("You chose {}", chosen.file_name().to_string_lossy());

    Ok(())
}

pub fn set_auto_accept(self, auto_accept: bool) -> Self

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

Examples found in repository

examples/starting_search.rs (line 7)

pub fn main() -> eyre::Result<()> {
    let nouns = vec!["dog", "cat", "house", "pickle", "mouse"];
    let chosen = PickerTui::new()
        .set_header("Pick a noun")
        .set_query("ouse")
        .pick_one(nouns)?;
    println!("You chose {}", chosen);

    Ok(())
}

pub fn pick_one<T>(&self, choices: impl IntoChoices<T>) -> PickResult<T>

Examples found in repository

examples/pick_a_noun.rs (line 5)

pub fn main() -> eyre::Result<()> {
    let nouns = vec!["dog", "cat", "house", "pickle", "mouse"];
    let chosen = PickerTui::new().set_header("Pick a noun").pick_one(nouns)?;
    println!("You chose {}", chosen);

    Ok(())
}

examples/starting_search.rs (line 8)

pub fn main() -> eyre::Result<()> {
    let nouns = vec!["dog", "cat", "house", "pickle", "mouse"];
    let chosen = PickerTui::new()
        .set_header("Pick a noun")
        .set_query("ouse")
        .pick_one(nouns)?;
    println!("You chose {}", chosen);

    Ok(())
}

examples/pick_a_path.rs (lines 14-17)

pub fn main() -> eyre::Result<()> {
    let mut choices = Vec::new();
    let dir = std::fs::read_dir(".")?;
    for entry in dir {
        let entry = entry?;
        choices.push(entry);
    }

    let chosen = PickerTui::new()
        .set_header("Pick a path")
        .pick_one(choices.into_iter().map(|entry| Choice {
            key: entry.path().display().to_string(), // the value shown to the user
            value: entry, // the inner value we want to have after the user picks
        }))?;

    println!("You chose {}", chosen.file_name().to_string_lossy());

    Ok(())
}

pub fn pick_many<T>(&self, choices: impl IntoChoices<T>) -> PickResult<Vec<T>>

Examples found in repository

examples/pick_many_nouns.rs (line 7)

pub fn main() -> eyre::Result<()> {
    let nouns = vec!["dog", "cat", "house", "pickle", "mouse"];
    let chosen = PickerTui::new()
        .set_header("Press tab to select entries")
        .pick_many(nouns)?;

    println!("You chose {:?}", chosen);

    Ok(())
}

examples/multiline.rs (line 11)

pub fn main() -> eyre::Result<()> {
    let choices = vec![
        "First\nSecond\nThird",
        "A\nB\nC",
        "IMPORT BRUH\nDO THING\nWOOHOO!",
        "single item",
        "another single item",
    ];
    let chosen = PickerTui::new().pick_many(choices)?;
    println!("You chose: {chosen:#?}");
    Ok(())
}

pub async fn pick_one_reloadable<T, F, C>( &self, choice_supplier: F, ) -> PickResult<T>

where F: AsyncFn(bool) -> Result<C>, C: IntoChoices<T>,

pub async fn pick_many_reloadable<T, F, C>( &self, choice_supplier: F, ) -> PickResult<Vec<T>>

where F: AsyncFn(bool) -> Result<C>, C: IntoChoices<T>,

pub async fn pick_inner_reloadable<T, F, C>( &self, many: bool, choice_supplier: F, ) -> PickResult<Vec<T>>

where F: AsyncFn(bool) -> Result<C>, C: IntoChoices<T>,

pub fn pick_inner<T>( &self, many: bool, choices: impl IntoChoices<T>, ) -> PickResult<Vec<T>>

Trait Implementations

impl Default for PickerTui

fn default() -> Self

Returns the “default value” for a type.