Struct password_hash::Ident

pub struct Ident<'a>(_);

Algorithm or parameter identifier.

This type encompasses both the "function symbolic name" and "parameter name" use cases as described in the PHC string format specification.

Constraints

• ASCII-encoded string consisting of the characters [a-z0-9-] (lowercase letters, digits, and the minus sign)
• Minimum length: 1 ASCII character (i.e. 1-byte)
• Maximum length: 32 ASCII characters (i.e. 32-bytes)

Implementations

impl<'a> Ident<'a>

pub const fn max_len() -> usize

Maximum length of an Ident - 32 ASCII characters (i.e. 32-bytes).

This value corresponds to the maximum size of a function symbolic names and parameter names according to the PHC string format.

pub const fn new(s: &'a str) -> Self

Parse an Ident from a string.

Panics

Must conform to the contraints given in the type-level documentation, or else it will panic.

This method is intended for use in a const context where instead of panicking it will cause a compile error.

For fallible non-panicking parsing of an Ident, use the TryFrom impl on this type instead.

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

Borrow this ident as a str

Trait Implementations

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

fn as_ref(&self) -> &str

Performs the conversion.

impl<'a> Clone for Ident<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Ident<'a>

impl<'a> Debug for Ident<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for Ident<'a>

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl<'a> Display for Ident<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Ident<'a>

impl<'a> Hash for Ident<'a>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for Ident<'a>

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'a> PartialEq<Ident<'a>> for Ident<'a>

fn eq(&self, other: &Ident<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Ident<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<Ident<'a>> for Ident<'a>

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

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

fn lt(&self, other: &Ident<'a>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Ident<'a>) -> bool

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

fn gt(&self, other: &Ident<'a>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Ident<'a>) -> bool

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

impl<'a> StructuralEq for Ident<'a>

impl<'a> StructuralPartialEq for Ident<'a>

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

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, ParseError>

Performs the conversion.