Enum argon2::Algorithm

pub enum Algorithm {
    Argon2d,
    Argon2i,
    Argon2id,
}

Argon2 primitive type: variants of the algorithm.

Variants

Argon2d

Optimizes against GPU cracking attacks but vulnerable to side-channels.

Accesses the memory array in a password dependent order, reducing the possibility of time–memory tradeoff (TMTO) attacks.

Argon2i

Optimized to resist side-channel attacks.

Accesses the memory array in a password independent order, increasing the possibility of time-memory tradeoff (TMTO) attacks.

Argon2id

Hybrid that mixes Argon2i and Argon2d passes (default).

Uses the Argon2i approach for the first half pass over memory and Argon2d approach for subsequent passes. This effectively places it in the "middle" between the other two: it doesn't provide as good TMTO/GPU cracking resistance as Argon2d, nor as good of side-channel resistance as Argon2i, but overall provides the most well-rounded approach to both classes of attacks.

Implementations

impl Algorithm

pub fn new(id: impl AsRef<str>) -> Result<Self, Error>

Parse an Algorithm from the provided string.

pub fn as_str(&self) -> &str

Get the identifier string for this PBKDF2 Algorithm.

pub fn ident(&self) -> Ident<'static>

This is supported on crate feature password-hash only.

Get the Ident that corresponds to this Argon2 Algorithm.

Trait Implementations

impl AsRef<str> for Algorithm

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for Algorithm

fn clone(&self) -> Algorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Algorithm

impl Debug for Algorithm

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

Formats the value using the given formatter.

impl Default for Algorithm

fn default() -> Algorithm

Returns the "default value" for a type.

impl Display for Algorithm

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

Formats the value using the given formatter.

impl Eq for Algorithm

impl FromStr for Algorithm

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Algorithm, Error>

Parses a string s to return a value of this type.

impl Ord for Algorithm

fn cmp(&self, other: &Algorithm) -> 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 PartialEq<Algorithm> for Algorithm

fn eq(&self, other: &Algorithm) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Algorithm> for Algorithm

fn partial_cmp(&self, other: &Algorithm) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for Algorithm

impl StructuralPartialEq for Algorithm

impl<'a> TryFrom<Ident<'a>> for Algorithm

This is supported on crate feature password-hash only.

type Error = HasherError

The type returned in the event of a conversion error.

fn try_from(ident: Ident<'a>) -> Result<Algorithm, HasherError>

Performs the conversion.