Struct bdrck::cli::MaybePromptedString

pub struct MaybePromptedString { /* private fields */ }

MaybePromptedString is a wrapper for getting user input interactively, while also allowing the value to be specified at call time. This is useful e.g. when we want to prompt users interactively, but want to predefine the values in unit tests, or when users can specify a value either interactively or via flags.

Implementations

impl MaybePromptedString

pub fn new<IS: AbstractStream, OS: AbstractStream>(
    provided: Option<&str>,
    input_stream: IS,
    output_stream: OS,
    prompt: &str,
    is_sensitive: bool,
    confirm: bool
) -> Result<Self>

Construct a new MaybePromptedString, either using the given value or prompting the user interactively with the given options.

pub fn was_provided(&self) -> bool

Returns true if this string was provided, or false if it is the result of an interactive prompt.

pub fn into_inner(self) -> String

“Unwraps” this structure into its underlying string.