Struct tag_password::Password

pub struct Password<T: ?Sized>(/* private fields */);

Represents password data that can be hashed and verified.

This struct encapsulates password data and supports hashing with the hash function, which can be enabled with the argon2 feature. It also provides verification functionality via the verify function.

Implementations

impl<T: ?Sized> Password<T>

pub fn new(value: impl Into<String>) -> Self

Creates a new Password instance from the provided value.

Arguments

• value: A value that can be converted into a String.

Returns a new Password instance with the provided value.

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

Retrieves the byte representation of the password value.

Returns a slice containing the bytes representing the password.

impl Password<Plain>

pub unsafe fn as_hashed(self) -> Password<Hashed>

Converts a plain text password into a hashed password.

Returns a new Password instance containing the hashed password.

pub fn hash<'a>( &self, argon2: Option<Argon2<'_>>, salt: impl Into<Salt<'a>> ) -> Result<Password<Hashed>>

Hashes the password using Argon2 (if the ‘argon2’ feature is enabled).

• argon2: An optional Argon2 configuration.
• salt: A salt value used for hashing.

Produces a result containing a new Password instance with the hashed value if successful. If hashing fails, an argon2::password_hash::Result with an error is returned.

impl Password<Hashed>

pub unsafe fn as_plain(self) -> Password<Plain>

Unsafely converts a hashed password into a plain text password. This operation is marked as unsafe because once a password is hashed, it cannot be converted back to plain text.

Returns a new Password instance containing the plain text password.

pub fn verify( &self, argon2: Option<Argon2<'_>>, plain: impl Into<Password<Plain>> ) -> Result<()>

Verifies if the hashed password matches the provided plain text password.

• argon2: An optional Argon2 configuration.
• plain: A plain text password used for verification.

Returns a result indicating success or failure of the verification process. If successful, Ok(()) is returned. If verification fails, an argon2::password_hash::Result with an error is returned.

Trait Implementations

impl<T: Clone + ?Sized> Clone for Password<T>

fn clone(&self) -> Password<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: ?Sized> Debug for Password<T>

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

Formats the Password for debugging purposes.

impl<'de, T: ?Sized> Deserialize<'de> for Password<T>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: ?Sized> Display for Password<T>

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

Formats the Password for displaying purposes.

impl<T: ?Sized> From<String> for Password<T>

fn from(value: String) -> Self

Converts the String instance to a Password.

impl<T: ?Sized> Into<String> for Password<T>

fn into(self) -> String

Converts the Password instance into a String.

impl<T: PartialEq + ?Sized> PartialEq for Password<T>

fn eq(&self, other: &Password<T>) -> bool

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

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

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

impl<T: ?Sized> Serialize for Password<T>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq + ?Sized> Eq for Password<T>

impl<T: ?Sized> StructuralEq for Password<T>

impl<T: ?Sized> StructuralPartialEq for Password<T>