Enum Algorithm 

#[non_exhaustive]
pub enum Algorithm {
    Sha256Crypt,
    Sha512Crypt,
}

Available on crate feature password-hash only.

SHA-crypt algorithm variants: SHA-256 or SHA-512.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Sha256Crypt

SHA-256-crypt: SHA-crypt instantiated with SHA-256.

Sha512Crypt

SHA-512-crypt: SHA-crypt instantiated with SHA-512.

Implementations

impl Algorithm

pub const SHA256_CRYPT_IDENT: &str = "5"

SHA-256-crypt Modular Crypt Format algorithm identifier

pub const SHA512_CRYPT_IDENT: &str = "6"

SHA-512-crypt Modular Crypt Format algorithm identifier

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

Parse an Algorithm from the provided string.

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

Get the Modular Crypt Format algorithm identifier for this algorithm.

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() -> Self

Recommended default algorithm: SHA-512.

impl Display for Algorithm

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

Formats the value using the given formatter.

impl From<Algorithm> for ShaCrypt

fn from(algorithm: Algorithm) -> Self

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(s: &str) -> Result<Algorithm>

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

impl Hash for Algorithm

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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<'a> TryFrom<&'a str> for Algorithm

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Algorithm

impl Eq for Algorithm

impl StructuralPartialEq for Algorithm