Struct inquire::Password

pub struct Password<'a> {
    pub message: &'a str,
    pub help_message: Option<&'a str>,
    pub formatter: StringFormatter<'a>,
    pub validators: Vec<StringValidator<'a>>,
}

Prompt meant for secretive text inputs.

It is a simple text prompt where the user’s input is captured and not echoed back to the terminal.

This prompt is meant to be as simple and raw as possible, not supporting features such as default values or auto-completion.

By default, the user submission is formatted as “********” (eight star characters).

This prompt still allows the caller to customize standard properties: validators, input formatter, error and help messages.

Example

use inquire::Password;

let name = Password::new("Encryption key:").prompt();

match name {
    Ok(_) => println!("This doesn't look like a key."),
    Err(_) => println!("An error happened when asking for your key, try again later."),
}

Fields

message: &'a str

Message to be presented to the user.

help_message: Option<&'a str>

Help message to be presented to the user.

formatter: StringFormatter<'a>

Function that formats the user input and presents it to the user as the final rendering of the prompt.

validators: Vec<StringValidator<'a>>

Collection of validators to apply to the user input.

Validators are executed in the order they are stored, stopping at and displaying to the user only the first validation error that might appear.

The possible error is displayed to the user one line above the prompt.

Implementations

impl<'a> Password<'a>

pub const DEFAULT_FORMATTER: StringFormatter<'a>

Default formatter, set to always display "********" regardless of input length.

pub const DEFAULT_VALIDATORS: Vec<StringValidator<'a>>

Default validators added to the Password prompt, none.

pub const DEFAULT_HELP_MESSAGE: Option<&'a str>

Default help message.

pub fn new(message: &'a str) -> Self

Creates a Password with the provided message and default options.

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

Sets the help message of the prompt.

pub fn with_formatter(self, formatter: StringFormatter<'a>) -> Self

Sets the formatter.

pub fn with_validator(self, validator: StringValidator<'a>) -> Self

Adds a validator to the collection of validators. You might want to use this feature in case you need to limit the user to specific choices, such as requiring special characters in the password.

Validators are executed in the order they are stored, stopping at and displaying to the user only the first validation error that might appear.

The possible error is displayed to the user one line above the prompt.

pub fn with_validators(self, validators: &[StringValidator<'a>]) -> Self

Adds the validators to the collection of validators in the order they are given.

Validators are executed in the order they are stored, stopping at and displaying to the user only the first validation error that might appear.

The possible error is displayed to the user one line above the prompt.

pub fn prompt(self) -> InquireResult<String>

Parses the provided behavioral and rendering options and prompts the CLI user for input according to the defined rules.

Trait Implementations

impl<'a> Clone for Password<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> From<&'a str> for Password<'a>

fn from(val: &'a str) -> Self

Performs the conversion.