Struct prompts::text::TextPrompt

pub struct TextPrompt { /* fields omitted */ }

Interactive prompt that accepts text input

Examples

use prompt::{text::TextPrompt, Prompt};
let mut prompt = TextPrompt::new("What is your name?");
match prompt.run().await {
    Ok(Some(s)) => println!("You wrote: {}", s),
    Ok(None) => println!("Prompt was aborted!"),
    Err(e) => println!("Some kind of crossterm error happened: {:?}", e),
}

Methods

impl TextPrompt

pub fn new<S>(message: S) -> TextPrompt where
    S: Into<String>, 

Returns a TextPrompt ready to be run

Arguments

• message - The message to display to the user before the prompt

pub fn with_style(self, style: Style) -> TextPrompt

Mask typed letters with a given style (currently only invisible or password)

Arguments

• style - The style to use

pub fn with_validator(
    self,
    validator: fn(input: &str) -> Result<(), String>
) -> TextPrompt

Provide a custom validation closure

Arguments

• validator - Validation closure that accepts a string, and returns Ok if valid, or a string error to show if invalid.

Trait Implementations

impl Debug for TextPrompt

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for TextPrompt

fn default() -> TextPrompt

Returns the "default value" for a type.

impl Prompt<String> for TextPrompt

fn run<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<Option<String>, ErrorKind>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn display(&mut self) -> Result<()>

fn handle_key_event(&mut self, event: KeyEvent)