Skip to main content

Prompt

Struct Prompt 

Source
pub struct Prompt { /* private fields */ }
Expand description

Prompt the user for a string.

§Example

use rusty_rich::Prompt;

let name = Prompt::ask_with("Enter name").unwrap();

Implementations§

Source§

impl Prompt

Source

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

Create a new string prompt.

Source

pub fn console(self, console: Console) -> Self

Builder: set the console.

Source

pub fn password(self, yes: bool) -> Self

Builder: enable password mode.

Source

pub fn choices(self, choices: Vec<String>) -> Self

Builder: set valid choices.

Source

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

Builder: set case sensitivity.

Source

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

Builder: show or hide choices.

Source

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

Builder: show or hide default.

Source

pub fn render(&self) -> String

Render the prompt string with styling applied.

Returns a styled string like "Enter name: " where the prompt text and choices are colored using the theme’s prompt and prompt.choices styles.

Source

pub fn ask(&self) -> Result<String, PromptError>

Ask the user for string input.

Displays the prompt, reads a line from stdin, validates it against any configured choices, and returns the trimmed string.

§Errors

Returns PromptError::Cancelled on EOF or Ctrl+C, PromptError::InvalidResponse when the input does not match choices, and PromptError::IOError on I/O failures.

Source

pub fn ask_with(prompt: impl Into<String>) -> Result<String, PromptError>

Convenience: create a prompt, ask, and return the result.

Equivalent to Prompt::new(prompt).ask().

Auto Trait Implementations§

§

impl Freeze for Prompt

§

impl !RefUnwindSafe for Prompt

§

impl Send for Prompt

§

impl !Sync for Prompt

§

impl Unpin for Prompt

§

impl UnsafeUnpin for Prompt

§

impl !UnwindSafe for Prompt

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.