Struct TextPromptSource 

pub struct TextPromptSource<T: TerminalIO = RealTerminal> { /* private fields */ }

Simple text input prompt.

Prompts the user for text input in the terminal. Only available when stdin is a TTY (not piped).

Example

use standout_input::{InputChain, ArgSource, TextPromptSource};

let chain = InputChain::<String>::new()
    .try_source(ArgSource::new("name"))
    .try_source(TextPromptSource::new("Enter your name: "));

let name = chain.resolve(&matches)?;

Implementations

impl TextPromptSource<RealTerminal>

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

Create a new text prompt source.

impl<T: TerminalIO> TextPromptSource<T>

pub fn with_terminal(prompt: impl Into<String>, terminal: T) -> Self

Create a text prompt with a custom terminal for testing.

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

Control whether to trim whitespace from the input.

Default is true.

Trait Implementations

impl<T: Clone + TerminalIO> Clone for TextPromptSource<T>

fn clone(&self) -> TextPromptSource<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: TerminalIO + 'static> InputCollector<String> for TextPromptSource<T>

fn name(&self) -> &'static str

Human-readable name for this collector.

fn is_available(&self, _matches: &ArgMatches) -> bool

Check if this collector can provide input in the current environment.

fn collect(&self, _matches: &ArgMatches) -> Result<Option<String>, InputError>

Attempt to collect input from this source.

fn can_retry(&self) -> bool

Whether this collector supports retry on validation failure.

fn validate(&self, _value: &T) -> Result<(), String>

Validate the collected value.