Struct Password

Source

pub struct Password<'a> { /* private fields */ }

Available on crate feature password only.

Expand description

Renders a password input prompt.

§Example

use dialoguer::Password;

fn main() {
    let password = Password::new()
        .with_prompt("New Password")
        .with_confirmation("Confirm password", "Passwords mismatching")
        .interact()
        .unwrap();

    println!("Your password length is: {}", password.len());
}

Implementations§

Source §

impl Password<'static>

Source

pub fn new() -> Password<'static>

Creates a password input prompt with default theme.

Source §

impl Password<'_>

Source

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

Sets the password input prompt.

Examples found in repository ?

examples/password.rs (line 5)

3fn main() {
4    let password = Password::with_theme(&ColorfulTheme::default())
5        .with_prompt("Password")
6        .with_confirmation("Repeat password", "Error: the passwords don't match.")
7        .validate_with(|input: &String| -> Result<(), &str> {
8            if input.chars().count() > 3 {
9                Ok(())
10            } else {
11                Err("Password must be longer than 3")
12            }
13        })
14        .interact()
15        .unwrap();
16
17    println!(
18        "Your password is {} characters long",
19        password.chars().count()
20    );
21}

Source

pub fn report(self, val: bool) -> Self

Indicates whether to report confirmation after interaction.

The default is to report.

Source

pub fn with_confirmation<A, B>(self, prompt: A, mismatch_err: B) -> Self
where A: Into<String>, B: Into<String>,

Enables confirmation prompting.

Examples found in repository ?

examples/password.rs (line 6)

3fn main() {
4    let password = Password::with_theme(&ColorfulTheme::default())
5        .with_prompt("Password")
6        .with_confirmation("Repeat password", "Error: the passwords don't match.")
7        .validate_with(|input: &String| -> Result<(), &str> {
8            if input.chars().count() > 3 {
9                Ok(())
10            } else {
11                Err("Password must be longer than 3")
12            }
13        })
14        .interact()
15        .unwrap();
16
17    println!(
18        "Your password is {} characters long",
19        password.chars().count()
20    );
21}

Source

pub fn allow_empty_password(self, allow_empty_password: bool) -> Self

Allows/Disables empty password.

By default this setting is set to false (i.e. password is not empty).

Source

pub fn interact(self) -> Result<String>

Enables user interaction and returns the result.

If the user confirms the result is Ok(), Err() otherwise. The dialog is rendered on stderr.

Examples found in repository ?

examples/password.rs (line 14)

3fn main() {
4    let password = Password::with_theme(&ColorfulTheme::default())
5        .with_prompt("Password")
6        .with_confirmation("Repeat password", "Error: the passwords don't match.")
7        .validate_with(|input: &String| -> Result<(), &str> {
8            if input.chars().count() > 3 {
9                Ok(())
10            } else {
11                Err("Password must be longer than 3")
12            }
13        })
14        .interact()
15        .unwrap();
16
17    println!(
18        "Your password is {} characters long",
19        password.chars().count()
20    );
21}

Source

pub fn interact_on(self, term: &Term) -> Result<String>

Like interact but allows a specific terminal to be set.

Source §

impl<'a> Password<'a>

Source

pub fn validate_with<V>(self, validator: V) -> Self
where V: PasswordValidator + 'a, V::Err: ToString,

Registers a validator.

§Example

use dialoguer::Password;

fn main() {
    let password: String = Password::new()
        .with_prompt("Enter password")
        .validate_with(|input: &String| -> Result<(), &str> {
            if input.chars().count() > 8 {
                Ok(())
            } else {
                Err("Password must be longer than 8")
            }
        })
        .interact()
        .unwrap();
}

Examples found in repository ?

examples/password.rs (lines 7-13)

3fn main() {
4    let password = Password::with_theme(&ColorfulTheme::default())
5        .with_prompt("Password")
6        .with_confirmation("Repeat password", "Error: the passwords don't match.")
7        .validate_with(|input: &String| -> Result<(), &str> {
8            if input.chars().count() > 3 {
9                Ok(())
10            } else {
11                Err("Password must be longer than 3")
12            }
13        })
14        .interact()
15        .unwrap();
16
17    println!(
18        "Your password is {} characters long",
19        password.chars().count()
20    );
21}

Source

pub fn with_theme(theme: &'a dyn Theme) -> Self

Creates a password input prompt with a specific theme.

§Example

use dialoguer::{theme::ColorfulTheme, Password};

fn main() {
    let password = Password::with_theme(&ColorfulTheme::default())
        .interact()
        .unwrap();
}

Examples found in repository ?

examples/password.rs (line 4)

3fn main() {
4    let password = Password::with_theme(&ColorfulTheme::default())
5        .with_prompt("Password")
6        .with_confirmation("Repeat password", "Error: the passwords don't match.")
7        .validate_with(|input: &String| -> Result<(), &str> {
8            if input.chars().count() > 3 {
9                Ok(())
10            } else {
11                Err("Password must be longer than 3")
12            }
13        })
14        .interact()
15        .unwrap();
16
17    println!(
18        "Your password is {} characters long",
19        password.chars().count()
20    );
21}