Struct Input

pub struct Input(/* private fields */);

A prompt that asks the user to enter text input

Implementations

impl Input

pub fn new() -> Result<Self, InteractionError>

Create the prompt, returning an error if interactive context is incorrectly set.

pub fn set_prompt(&mut self, prompt: String)

Set the prompt.

pub fn with_prompt<S: ToString>(&mut self, prompt: S) -> &mut Self

Builder pattern for Self::set_prompt

pub fn interact(&mut self) -> Result<String, InteractionError>

Present the prompt to the user. May return an error if in a non-interactive context, or interaction fails for any other reason

impl Input

pub fn set_default(&mut self, value: String)

Set the default selection. If the user does not input anything, this value will be used instead.

pub fn with_default<I: Into<String>>(&mut self, value: I) -> &mut Self

Builder pattern for Self::set_default

impl Input

pub fn set_allow_empty(&mut self, empty: bool)

Sets if no input is a valid input. Default: false.

pub fn with_allow_empty(&mut self, empty: bool) -> &mut Self

Builder pattern for Self::set_allow_empty

pub fn set_validator<V, E>(&mut self, validator: V)

where V: Fn(&String) -> Result<(), E> + 'static, E: ToString,

Set a validator to be run on input. If the validator returns Ok, the input will be deemed valid. If the validator returns Err, the prompt will display the error message

pub fn with_validator<V, E>(&mut self, validator: V) -> &mut Self

where V: Fn(&String) -> Result<(), E> + 'static, E: ToString,

Builder pattern for Self::set_validator

impl Input

pub fn set_inital_text<S: ToString>(&mut self, text: S)

pub fn with_initial_text<S: ToString>(&mut self, text: S) -> &mut Self