Struct password_hash::PasswordHashString

pub struct PasswordHashString { /* private fields */ }

Available on crate feature alloc only.

Serialized PasswordHash.

This type contains a serialized password hash string which is ensured to parse successfully.

Implementations

impl PasswordHashString

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

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

pub fn parse(s: &str, encoding: Encoding) -> Result<Self>

Parse a password hash from the given Encoding.

pub fn password_hash(&self) -> PasswordHash<'_>

Parse this owned string as a PasswordHash.

pub fn encoding(&self) -> Encoding

Get the Encoding that this PasswordHashString is serialized with.

pub fn as_str(&self) -> &str

Borrow this value as a str.

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

Borrow this value as bytes.

pub fn len(&self) -> usize

Get the length of this value in ASCII characters.

pub fn algorithm(&self) -> Ident<'_>

Password hashing algorithm identifier.

pub fn version(&self) -> Option<Decimal>

Optional version field.

pub fn params(&self) -> ParamsString

Algorithm-specific parameters.

pub fn salt(&self) -> Option<Salt<'_>>

Salt string for personalizing a password hash output.

pub fn hash(&self) -> Option<Output>

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

Trait Implementations

impl AsRef<str> for PasswordHashString

fn as_ref(&self) -> &str

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

impl Clone for PasswordHashString

fn clone(&self) -> PasswordHashString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PasswordHashString

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

Formats the value using the given formatter.

impl Display for PasswordHashString

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

Formats the value using the given formatter.

impl From<&PasswordHash<'_>> for PasswordHashString

fn from(hash: &PasswordHash<'_>) -> PasswordHashString

Converts to this type from the input type.

impl From<PasswordHash<'_>> for PasswordHashString

fn from(hash: PasswordHash<'_>) -> PasswordHashString

Converts to this type from the input type.

impl FromStr for PasswordHashString

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 PasswordHashString

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

impl StructuralPartialEq for PasswordHashString