Struct casual::Input

pub struct Input<T> { /* fields omitted */ }

An input builder.

Implementations

impl<T> Input<T>

pub fn new() -> Self

Construct a new empty Input.

pub fn prompt<S>(self, prompt: S) -> Self where
    S: Into<String>, 

Set the prompt to display before waiting for user input.

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

Set the default value.

If set, this will be returned in the event the user enters an empty input.

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

Check input values.

If set, this function will be called on the parsed user input and only if it passes will we return the value.

Examples

let num: u32 = Input::new().matches(|x| *x != 10).get()

impl<T> Input<T> where
    T: FromStr,
    <T as FromStr>::Err: Display, 

pub fn get(self) -> T

Consumes the Input and reads the input from the user.

This function uses FromStr to parse the input data.

pub fn check<F>(self, check: F) -> bool where
    F: Fn(T) -> bool, 

Consumes the Input and checks the result.

This function uses FromStr to parse the input data. The result is then fed to the given closure.

Trait Implementations

impl<T> Debug for Input<T> where
    T: Debug, 

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T> Default for Input<T>

fn default() -> Self

Returns the "default value" for a type.