Struct PasswordHash 

pub struct PasswordHash {
    pub algorithm: Ident,
    pub version: Option<Decimal>,
    pub params: ParamsString,
    pub salt: Option<Salt>,
    pub hash: Option<Output>,
}

Password hash.

This type corresponds to the parsed representation of a PHC string as described in the PHC string format specification.

PHC strings have the following format:

$<id>[$v=<version>][$<param>=<value>(,<param>=<value>)*][$<salt>[$<hash>]]

where:

• <id> is the symbolic name for the function
• <version> is the algorithm version
• <param> is a parameter name
• <value> is a parameter value
• <salt> is an encoding of the salt
• <hash> is an encoding of the hash output

The string is then the concatenation, in that order, of:

• a $ sign;
• the function symbolic name;
• optionally, a $ sign followed by the algorithm version with a v=version format;
• optionally, a $ sign followed by one or several parameters, each with a name=value format; the parameters are separated by commas;
• optionally, a $ sign followed by the (encoded) salt value;
• optionally, a $ sign followed by the (encoded) hash output (the hash output may be present only if the salt is present).

Fields

algorithm: Ident

Password hashing algorithm identifier.

This corresponds to the <id> field in a PHC string, a.k.a. the symbolic name for the function.

version: Option<Decimal>

Optional version field.

This corresponds to the <version> field in a PHC string.

params: ParamsString

Algorithm-specific parameters.

This corresponds to the set of $<param>=<value>(,<param>=<value>)* name/value pairs in a PHC string.

salt: Option<Salt>

Salt string for personalizing a password hash output.

This corresponds to the <salt> value in a PHC string.

hash: Option<Output>

Password hashing function Output, a.k.a. hash/digest.

This corresponds to the <hash> output in a PHC string.

Implementations

impl PasswordHash

pub fn new(s: &str) -> Result<Self>

Parse a password hash from a string in the PHC string format.

Trait Implementations

impl Clone for PasswordHash

fn clone(&self) -> PasswordHash

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PasswordHash

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

Formats the value using the given formatter.

impl Display for PasswordHash

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

Formats the value using the given formatter.

impl FromStr for PasswordHash

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl PartialEq for PasswordHash

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<&str> for PasswordHash

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self>

Performs the conversion.

impl Eq for PasswordHash

impl StructuralPartialEq for PasswordHash