Struct coreutils_core::input::Input

pub struct Input<'a> { /* fields omitted */ }

The Input struct handles issuing messages and getting responses from the user.

Example

To ask the user whether they want to make a change or not, and validate their response into a bool, the Input struct can be used like so:

let answer: bool = Input::new()
    .with_msg("Do you want to make this change?")
    .with_err_msg("Error! Failure to read!")
    .is_affirmative();

assert_eq!(answer, true);

One could also get the response directly from the user like so:

let answer: String = Input::new()
    .with_msg("Do you want to make this change?")
    .with_err_msg("Error! Failure to read!")
    .get();

assert_eq!(answer, String::from("Yes, I do"));

Methods

impl<'a> Input<'a>

pub const fn new() -> Self

Initializes a new Input builder.

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

Specifies the message to display to the user.

pub fn with_err_msg(&mut self, err_msg: &'a str) -> &mut Self

Specifies the error message to display to the user. NOTE: This error message prepends the actual error message produced.

pub fn get(&self) -> Option<String>

Gets the input value the user entered as a String.

pub fn is_affirmative(&self) -> bool

Verifies whether the user input is considered an 'affirmative' answer.

Trait Implementations

impl<'a> Clone for Input<'a>

fn clone(&self) -> Input<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Input<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Input<'a>

fn default() -> Input<'a>

Returns the "default value" for a type.