Struct email_pass::Password

pub struct Password<State = Encrypt> { /* private fields */ }

Safe-access password abstraction.

Implementations

impl Password

pub fn new(raw_password: &str) -> Password<Raw>

pub fn from_raw(raw_password: &str) -> Password<Raw>

Create a non encrypt password.

pub fn from_encrypt( encrypted_password: &str ) -> Result<Password<Encrypt>, PasswordError>

Create an encrypt password, check if password is really hashed.

pub fn verify(&self, raw_password: &Password<Raw>) -> Result<bool, BcryptError>

pub fn as_str(&self) -> &str

Extracts the inner value from Password<Encrypt>.

impl Password<Raw>

pub fn check(self) -> Result<Self, PasswordError>

Check the password’s strong, use PasswordStrengthChecker with default values. If you want change this values, use Password<Raw>::custom_check.

pub fn custom_check( self, checker: PasswordStrengthChecker ) -> Result<Self, PasswordError>

Check the password’s strong

Examples

Hard strong password example:

 use email_pass::{Password, PasswordStrengthChecker, PasswordStrength};

 let checker = PasswordStrengthChecker::new()
         .min_len(20)
         .strong(PasswordStrength::Hard);

 let password_err = Password::new("my.passphrase.0-9").custom_check(checker);
 assert!(password_err.is_err());

Low strong password example:

 use email_pass::{Password, PasswordStrengthChecker, PasswordStrength};

 let checker = PasswordStrengthChecker::new()
         .min_len(8)
         .strong(PasswordStrength::Low);

 let raw_password = Password::new("1234567azhc").custom_check(checker);
 assert!(raw_password.is_ok());

pub fn to_encrypt(self, cost: u32) -> Result<Password<Encrypt>, BcryptError>

Transforms Password<Raw> to Password<Encrypt>, encrypting the inner value based in a cost value. This method not checks the password’s strong.

pub fn to_encrypt_default(self) -> Result<Password<Encrypt>, BcryptError>

Transforms Password<Raw> to Password<Encrypt>, just encrypting the inner value. This method not checks the password’s strong.

pub fn to_encrypt_with_cost( self, cost: u32 ) -> Result<Password<Encrypt>, BcryptError>

Transforms Password<Raw> to Password<Encrypt>, encrypting the inner value based in a cost value. This method not checks the password’s strong.

Trait Implementations

impl AsRef<str> for Password<Encrypt>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<State: Clone> Clone for Password<State>

fn clone(&self) -> Password<State>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Password<Encrypt>

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

Formats the value using the given formatter.

impl Display for Password<Encrypt>

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

Formats the value using the given formatter.

impl<State: PartialEq> PartialEq for Password<State>

fn eq(&self, other: &Password<State>) -> 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<State: Eq> Eq for Password<State>

impl<State> StructuralEq for Password<State>

impl<State> StructuralPartialEq for Password<State>