Struct Prompt 

pub struct Prompt { /* private fields */ }

Ask for a line of text. Port of rich.prompt.Prompt.

let console = Console::new();
let name = Prompt::new("What is your name").ask(&console, Some("World")).unwrap();

Implementations

impl Prompt

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

pub fn choices( self, choices: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Restrict answers to choices, shown as [a/b/c].

pub fn case_sensitive(self, case_sensitive: bool) -> Self

Match choices regardless of case, returning the choice as spelled in the list rather than as typed.

pub fn show_default(self, show: bool) -> Self

Hide the (default) hint while still accepting an empty answer.

pub fn show_choices(self, show: bool) -> Self

Hide the [a/b/c] hint while still enforcing the choices.

pub fn make_prompt(&self, console: &Console, default: Option<&str>) -> Text

The rendered question, as ask would print it.

pub fn process_response(&self, value: &str) -> Result<String, InvalidResponse>

Validate one answer. Port of PromptBase.process_response.

pub fn ask(&self, console: &Console, default: Option<&str>) -> Result<String>

Ask on standard input, re-asking until the answer validates.

pub fn ask_from( &self, console: &Console, input: &mut dyn InputSource, default: Option<&str>, ) -> Result<String>

As ask, reading from input. Port of PromptBase.__call__.

An empty answer takes the default when there is one. Exhausted input does the same, rather than looping forever.

Trait Implementations

impl Clone for Prompt

fn clone(&self) -> Prompt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Prompt

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

Formats the value using the given formatter.