# Function crypto::scrypt::scrypt_simple [−] [src]

    pub fn scrypt_simple(password: &str, params: &ScryptParams) -> Result<String>

scrypt_simple is a helper function that should be sufficient for the majority of cases where an application needs to use Scrypt to hash a password for storage. The result is a String that contains the parameters used as part of its encoding. The scrypt_check function may be used on a password to check if it is equal to a hashed value.

# Format

The format of the output is a modified version of the Modular Crypt Format that encodes algorithm used and the parameter values. If all parameter values can each fit within a single byte, a compact format is used (format 0). However, if any value cannot, an expanded format where the r and p parameters are encoded using 4 bytes (format 1) is used. Both formats use a 128-bit salt and a 256-bit hash. The format is indicated as "rscrypt" which is short for "Rust Scrypt format."

$rscrypt$<format>$<base64(log_n,r,p)>$<base64(salt)>$<based64(hash)>$

# Arguments

- password - The password to process as a str
- params - The ScryptParams to use

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)