Struct Config 

pub struct Config { /* private fields */ }

Password hash configuration parameters.

Config::interactive is the default and is suitable for online authentication. Config::moderate and Config::sensitive spend more time and memory per password guess. Benchmark the chosen preset on the slowest supported system, and account for the number of concurrent hashes when setting memory limits.

Implementations

impl Config

pub fn with_algorithm(self, algorithm: PasswordHashAlgorithm) -> Self

Selects the password-hashing algorithm.

The preset resource limits target Argon2id. When selecting Argon2i, choose limits that satisfy the corresponding CRYPTO_PWHASH_ARGON2I_* constants.

pub fn with_hash_length(self, hash_length: usize) -> Self

Sets the hash output length in bytes.

The length must be between CRYPTO_PWHASH_BYTES_MIN and CRYPTO_PWHASH_BYTES_MAX, inclusive. Invalid values are reported when the config is used to hash a password.

pub fn with_memlimit(self, memlimit: usize) -> Self

Sets the approximate memory cost in bytes.

More memory makes parallel guessing more expensive, but every concurrent hash also consumes that memory. The value must be between CRYPTO_PWHASH_MEMLIMIT_MIN and CRYPTO_PWHASH_MEMLIMIT_MAX, inclusive.

pub fn with_opslimit(self, opslimit: u64) -> Self

Sets the computation cost.

Larger values take longer and make each password guess more expensive. The supported range depends on the selected algorithm. See the CRYPTO_PWHASH_ARGON2I_OPSLIMIT_* and CRYPTO_PWHASH_ARGON2ID_OPSLIMIT_* constants.

pub fn interactive() -> Self

Returns libsodium’s interactive password hashing configuration.

This is the default preset for online operations where users wait for the result.

pub fn moderate() -> Self

Returns libsodium’s moderate password hashing configuration.

This preset uses more time and memory than Config::interactive.

pub fn sensitive() -> Self

Returns libsodium’s sensitive password hashing configuration.

This preset has the highest resource requirements. Use it only when the deployment can tolerate its latency and memory use.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Zeroize for Config

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.