Struct password_hash::Value
source · [−]pub struct Value<'a>(_);
Expand description
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
sourceimpl<'a> Value<'a>
impl<'a> Value<'a>
sourcepub const MAX_LENGTH: usize = 64usize
pub const MAX_LENGTH: usize = 64usize
sourcepub fn new(input: &'a str) -> Result<Self>
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.
sourcepub fn b64_decode<'b>(&self, buf: &'b mut [u8]) -> Result<&'b [u8]>
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.
sourcepub fn as_bytes(&self) -> &'a [u8]ⓘNotable traits for &mut [u8]impl<'_> Write for &mut [u8]impl<'_> Read for &[u8]
pub fn as_bytes(&self) -> &'a [u8]ⓘNotable traits for &mut [u8]impl<'_> Write for &mut [u8]impl<'_> Read for &[u8]
Borrow this value as bytes.
sourcepub fn decimal(&self) -> Result<Decimal>
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>()
sourcepub fn is_decimal(&self) -> bool
pub fn is_decimal(&self) -> bool
Does this value parse successfully as a decimal?
Trait Implementations
sourceimpl<'a> Ord for Value<'a>
impl<'a> Ord for Value<'a>
sourceimpl<'a> PartialOrd<Value<'a>> for Value<'a>
impl<'a> PartialOrd<Value<'a>> for Value<'a>
sourcefn partial_cmp(&self, other: &Value<'a>) -> Option<Ordering>
fn partial_cmp(&self, other: &Value<'a>) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl<'a> Copy for Value<'a>
impl<'a> Eq for Value<'a>
impl<'a> StructuralEq for Value<'a>
impl<'a> StructuralPartialEq for Value<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for Value<'a>
impl<'a> Send for Value<'a>
impl<'a> Sync for Value<'a>
impl<'a> Unpin for Value<'a>
impl<'a> UnwindSafe for Value<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more