Enum Algorithm 

pub enum Algorithm {
    Argon2d = 0,
    Argon2i = 1,
    Argon2id = 2,
}

Argon2 primitive type: variants of the algorithm.

Variants

Argon2d = 0

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 = 1

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 = 2

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>

Parse an Algorithm from the provided string.

Errors

Returns Error::AlgorithmInvalid if id is not a valid Argon2 algorithm identifier.

pub const fn as_str(&self) -> &'static str

Get the identifier string for this PBKDF2 Algorithm.

pub const fn ident(&self) -> Ident

Get the Ident that corresponds to this Argon2 Algorithm.

pub(crate) const fn to_le_bytes(self) -> [u8; 4]

Serialize primitive type as little endian bytes

Trait Implementations

impl AsRef<str> for Algorithm

fn as_ref(&self) -> &str

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

impl Clone for Algorithm

fn clone(&self) -> Algorithm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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 From<Algorithm> for Ident

Available on crate feature password-hash only.

fn from(alg: Algorithm) -> Ident

Converts to this type from the input type.

impl FromStr for Algorithm

type Err = Error

The associated error which can be returned from parsing.

fn from_str(name: &str) -> Result<Algorithm>

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.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Algorithm

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<&str> for Algorithm

Available on crate feature password-hash only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(name: &str) -> Result<Algorithm>

Performs the conversion.

impl Copy for Algorithm

impl Eq for Algorithm

impl StructuralPartialEq for Algorithm