Struct read_input::InputBuilder

pub struct InputBuilder<'a, T: FromStr> { /* private fields */ }

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

Implementations

impl<'a, T: FromStr> InputBuilder<'a, T>

pub fn new() -> InputBuilder<'a, T>

Creates a new instance of InputBuilder with default settings.

pub fn msg(self, msg: &'a str) -> Self

Changes or adds a prompt message. This is documented in the readme

pub fn repeat_msg(self, msg: &'a str) -> Self

Changes or adds a prompt message and makes it repeat. This is documented in the readme

pub fn err(self, err: &'a str) -> Self

Changes fallback error message. This is documented in the readme

pub fn default(self, default: T) -> Self

Changes or adds a default input value. This is documented in the readme

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

Adds a validation check on input. This is documented in the readme

pub fn add_err_test<F: 'static + Fn(&T) -> bool>(
    self,
    test: F,
    err: &'a str
) -> Self

Adds a validation check on input with custom error message. This is documented in the readme

pub fn clear_tests(self) -> Self

Removes all validation checks made by .add_test() and .add_err_test().

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

Used specify custom error messages that depend on the errors produced by from_str(). This is documented in the readme

pub fn get(self) -> T

‘gets’ the input form the user. This is documented in the readme