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.

Identical to Input::default().

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

Set the prompt to display before waiting for user input.

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

Set the prompt prefix.

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

Set the prompt suffix.

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.

let num: u32 = Input::new().prompt("Enter a number: ").get();

pub fn map<F, U>(self, map: F) -> U where
    F: Fn(T) -> U, 

Consumes the Input and applies the given function to it.

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

let value = Input::new().map(|s: String| &s.to_lowercase() == "yes");

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T> Default for Input<T>

fn default() -> Self

Construct a new empty Input.

Identical to Input::new().