Struct psph::Hash

#[non_exhaustive]
pub struct Hash {
    pub password: String,
    pub hash: String,
}

A struct for storing and verifying hashed passwords based on the blake3 crate.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

password: String

The password.

hash: String

The password hash.

Implementations

impl Hash

pub fn entropy(&self) -> f64

Calculates the entropy of the hash in bits based on the Shannon entropy formula. https://en.wikipedia.org/wiki/Entropy`

pub fn generate_hash(&self) -> String

Hashes the password.

pub fn hash(&self) -> &str

Returns the hash.

pub fn hash_length(&self) -> usize

Returns the hash length.

pub fn new() -> Hash

Returns a new instance of Hash.

pub fn password(&self) -> &str

Returns the password.

pub fn password_length(&self) -> usize

Returns the password length.

pub fn set_hash(&mut self, hash: &str)

Sets the hash.

pub fn set_password(&mut self, password: &str)

Sets the password and updates the hash.

pub fn verify(&self, hash: &str, password: &str) -> bool

Verifies the password against the stored hash.

Returns true if the password and hash match, false otherwise.

Trait Implementations

impl Clone for Hash

fn clone(&self) -> Hash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hash

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

Formats the value using the given formatter.

impl Default for Hash

fn default() -> Hash

Returns the “default value” for a type.

impl Display for Hash

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

Formats the value using the given formatter.

impl PartialEq<Hash> for Hash

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

fn partial_cmp(&self, other: &Hash) -> 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 Hash