Struct password_hash::Value

pub struct Value<'a>(/* private fields */);

Algorithm parameter value string.

Parameter values are defined in the PHC string format specification.

Constraints

• ASCII-encoded string consisting of the characters [a-zA-Z0-9/+.-] (lowercase letters, digits, and the minus sign)
• Minimum length: 0 (i.e. empty values are allowed)
• Maximum length: 64 ASCII characters (i.e. 64-bytes)

Additional Notes

The PHC spec allows for algorithm-defined maximum lengths for parameter values, however this library defines a Value::MAX_LENGTH of 64 ASCII characters.

Implementations

impl<'a> Value<'a>

pub const MAX_LENGTH: usize = 64usize

Maximum length of an Value - 64 ASCII characters (i.e. 64-bytes).

This value is selected to match the maximum length of a Salt as this library internally uses this type to represent salts.

pub fn new(input: &'a str) -> Result<Self>

Parse a Value from the provided str, validating it according to the PHC string format’s rules.

pub fn b64_decode<'b>(&self, buf: &'b mut [u8]) -> Result<&'b [u8]>

Attempt to decode a B64-encoded Value, writing the decoded result into the provided buffer, and returning a slice of the buffer containing the decoded result on success.

Examples of “B64”-encoded parameters in practice are the keyid and data parameters used by the Argon2 Encoding as described in the PHC string format specification.

pub fn as_str(&self) -> &'a str

Borrow this value as a str.

pub fn as_bytes(&self) -> &'a [u8]

Borrow this value as bytes.

pub fn len(&self) -> usize

Get the length of this value in ASCII characters.

pub fn is_empty(&self) -> bool

Is this value empty?

pub fn decimal(&self) -> Result<Decimal>

Attempt to parse this Value as a PHC-encoded decimal (i.e. integer).

Decimal values are integers which follow the rules given in the “Decimal Encoding” section of the PHC string format specification.

The decimal encoding rules are as follows:

For an integer value x, its decimal encoding consist in the following:

• If x < 0, then its decimal encoding is the minus sign - followed by the decimal encoding of -x.
• If x = 0, then its decimal encoding is the single character 0.
• If x > 0, then its decimal encoding is the smallest sequence of ASCII digits that matches its value (i.e. there is no leading zero).

Thus, a value is a valid decimal for an integer x if and only if all of the following hold true:

• The first character is either a - sign, or an ASCII digit.
• All characters other than the first are ASCII digits.
• If the first character is - sign, then there is at least another character, and the second character is not a 0.
• If the string consists in more than one character, then the first one cannot be a 0.

Note: this implementation does not support negative decimals despite them being allowed per the spec above. If you need to parse a negative number, please parse it from the string representation directly e.g. value.as_str().parse::<i32>()

pub fn is_decimal(&self) -> bool

Does this value parse successfully as a decimal?

Trait Implementations

impl<'a> AsRef<str> for Value<'a>

fn as_ref(&self) -> &str

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

impl<'a> Clone for Value<'a>

fn clone(&self) -> Value<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Value<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Value<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for Value<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for Value<'a>

fn cmp(&self, other: &Value<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<'a> PartialEq for Value<'a>

fn eq(&self, other: &Value<'a>) -> 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<'a> PartialOrd for Value<'a>

fn partial_cmp(&self, other: &Value<'a>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> TryFrom<&Value<'a>> for Decimal

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value<'a>) -> Result<Decimal>

Performs the conversion.

impl<'a> TryFrom<&'a str> for Value<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(input: &'a str) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<Value<'a>> for Decimal

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value<'a>) -> Result<Decimal>

Performs the conversion.

impl<'a> Copy for Value<'a>

impl<'a> Eq for Value<'a>

impl<'a> StructuralPartialEq for Value<'a>