Struct read_input::InputBuilder

pub struct InputBuilder<T: FromStr> { /* fields omitted */ }

‘builder’ used to store the settings that are used to fetch input.

.get() method only takes these settings by reference so can be called multiple times.

This type does not have support for default input value.

Implementations

impl<T: FromStr> InputBuilder<T>

pub fn new() -> Self

Creates a new instance of InputBuilder with default settings.

pub fn get(&self) -> T

‘gets’ the input form the user.

Panics if unable to read input line.

pub fn try_get(&self) -> Result<T>

‘gets’ the input form the user.

Errors

Returns Err if unable to read input line.

pub fn default(self, default: T) -> InputBuilderOnce<T>

Changes or adds a default input value.

If the user presses enter before typing anything .get() will return a default value when InputBuilder::default is used.

let input = input().msg("Please input pi: ").default(3.141).get();

Trait Implementations

impl<T: FromStr + Clone> Clone for InputBuilder<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: FromStr> Default for InputBuilder<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: FromStr> InputBuild<T> for InputBuilder<T>

fn msg(self, msg: impl ToString) -> Self

Changes or adds a prompt message that gets printed once when input if fetched.

fn repeat_msg(self, msg: impl ToString) -> Self

Changes or adds a prompt message and that is repeated each time input is requested.

fn err(self, err: impl ToString) -> Self

Changes fallback error message.

fn add_test<F: Fn(&T) -> bool + 'static>(self, test: F) -> Self

Adds a validation check on input to ensure the value meets your criteria.

fn add_err_test<F>(self, test: F, err: impl ToString) -> Self where
    F: Fn(&T) -> bool + 'static, 

Does the same thing as InputBuild::err, but with a custom error message printed when the test fails.

fn clear_tests(self) -> Self

Removes all validation checks made by InputBuild::add_test, InputBuild::add_err_test, InputBuild::inside and InputBuild::inside_err.

fn err_match<F>(self, err_match: F) -> Self where
    F: Fn(&T::Err) -> Option<String> + 'static, 

Used specify custom error messages that depend on the errors produced by FromStr.

fn inside<U: InsideFunc<T>>(self, constraint: U) -> Self

Ensures that input is within a range, array or vector.

fn inside_err<U: InsideFunc<T>>(self, constraint: U, err: impl ToString) -> Self

Does the same thing as InputBuild::inside, but with a custom error message printed when input fails.

fn toggle_msg_repeat(self) -> Self

Toggles whether a prompt message gets printed once or each time input is requested.

fn prompting_on(self, prompt_output: RefCell<Box<dyn Write>>) -> Self

Send prompts to custom writer instead of stdout

fn prompting_on_stderr(self) -> Self

Send prompts to stderr instead of stdout

impl<T: FromStr + PartialOrd + 'static> InputConstraints<T> for InputBuilder<T>

fn min(self, min: T) -> Self

Sets a minimum input value.

fn min_err(self, min: T, err: impl ToString) -> Self

Sets a minimum input value with custom error message.

fn max(self, max: T) -> Self

Sets a maximum input value.

fn max_err(self, max: T, err: impl ToString) -> Self

Sets a maximum input value with custom error message.

fn min_max(self, min: T, max: T) -> Self

Sets a minimum and maximum input value.

fn min_max_err(self, min: T, max: T, err: impl ToString) -> Self

Sets a minimum and maximum input value with custom error message.

fn not(self, this: T) -> Self

Sets a restricted input value.

fn not_err(self, this: T, err: impl ToString) -> Self

Sets a restricted input value with custom error message.