Struct psph::Password

#[non_exhaustive]
pub struct Password { /* private fields */ }

A random password / passphrase generator. The generated password is a string of three words separated by hyphens. Each word is between 6 and 8 characters long. The first character of each word is capitalized.

Implementations

impl Password

pub fn entropy(&self) -> f64

Calculates the entropy of a password based on its length, the number of unique characters used in the password and the number of bits of the hash generated from the password.

Arguments

• &self - An immutable reference to the password.

Returns

• f64 - The calculated entropy of the password.

Entropy Ranges

The following ranges can give you an idea of how the entropy is considered:

• Poor: less than 40 bits
• Weak: 40-55 bits
• Reasonable: 56-70 bits
• Strong: 71-80 bits
• Excellent: 81 bits and above

Keep in mind that these values are just rough estimates and the actual entropy of a password depends on the distribution of characters used in the password and the number of unique characters in it, and not just its length.

pub fn hash(&self) -> String

Returns the hash of the generated passphrase.

pub fn hash_length(&self) -> usize

Returns the hash length.

pub fn is_empty(&self) -> bool

Returns true if the generated passphrase is empty. Returns false if the generated passphrase is not empty.

pub fn len(&self) -> usize

Returns the length of the generated passphrase.

pub fn new(len: u8, separator: &str, special_chars: Vec<char>) -> Self

Returns the generated passphrase.

pub fn passphrase(&self) -> &str

Returns the generated passphrase.

pub fn password_length(&self) -> usize

Returns the password length.

pub fn set_passphrase(&mut self, passphrase: &str)

Sets the generated passphrase.

Trait Implementations

impl Clone for Password

fn clone(&self) -> Password

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Password

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

Formats the value using the given formatter.

impl Default for Password

fn default() -> Self

Default to a passphrase of 4 words.

impl Display for Password

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

Display the generated passphrase.

impl PartialEq<Password> for Password

fn eq(&self, other: &Password) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Password> for Password

fn partial_cmp(&self, other: &Password) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Password