Struct promkit::Prompt

pub struct Prompt<T: Renderer> {
    pub renderer: T,
}

Represents a customizable prompt that can handle user input and produce a result.

This struct encapsulates the rendering logic, event handling, and result production for a prompt.

Fields

renderer: T

Implementations

impl<T: Renderer> Prompt<T>

pub fn run(&mut self) -> Result<T::Return>

Runs the prompt, handling events and producing a result.

This method initializes the terminal, and enters a loop to handle events until a quit signal is received. After exiting the loop, it produces and returns the result.

Returns

Returns a Result containing the produced result or an error.

Examples found in repository

examples/confirm.rs (line 5)

fn main() -> anyhow::Result<()> {
    let mut p = Confirm::new("Do you have a pet?").prompt()?;
    println!("result: {:?}", p.run()?);
    Ok(())
}

examples/listbox.rs (line 7)

fn main() -> anyhow::Result<()> {
    let mut p = Listbox::new(0..100)
        .title("What number do you like?")
        .prompt()?;
    println!("result: {:?}", p.run()?);
    Ok(())
}

examples/tree.rs (line 8)

fn main() -> anyhow::Result<()> {
    let mut p = Tree::new(Node::try_from(&std::env::current_dir()?.join("src"))?)
        .title("Select a directory or file")
        .tree_lines(10)
        .prompt()?;
    println!("result: {:?}", p.run()?);
    Ok(())
}

examples/password.rs (line 11)

fn main() -> anyhow::Result<()> {
    let mut p = Password::default()
        .title("Put your password")
        .validator(
            |text| 4 < text.len() && text.len() < 10,
            |text| format!("Length must be over 4 and within 10 but got {}", text.len()),
        )
        .prompt()?;
    println!("result: {:?}", p.run()?);
    Ok(())
}

examples/checkbox.rs (line 19)

fn main() -> anyhow::Result<()> {
    let mut p = Checkbox::new(vec![
        "Apple",
        "Banana",
        "Orange",
        "Mango",
        "Strawberry",
        "Pineapple",
        "Grape",
        "Watermelon",
        "Kiwi",
        "Pear",
    ])
    .title("What are your favorite fruits?")
    .checkbox_lines(5)
    .prompt()?;
    println!("result: {:?}", p.run()?);
    Ok(())
}

examples/readline.rs (line 17)

fn main() -> anyhow::Result<()> {
    let mut p = Readline::default()
        .title("Hi!")
        .enable_suggest(Suggest::from_iter([
            "apple",
            "applet",
            "application",
            "banana",
        ]))
        .validator(
            |text| text.len() > 10,
            |text| format!("Length must be over 10 but got {}", text.len()),
        )
        .prompt()?;
    println!("result: {:?}", p.run()?);
    Ok(())
}

Additional examples can be found in:

• examples/query_selector.rs
• examples/json.rs

Trait Implementations

impl<T: Renderer> Drop for Prompt<T>

fn drop(&mut self)

Executes the destructor for this type.