Struct Params 

pub struct Params { /* private fields */ }

yescrypt algorithm parameters.

Params::default provides the recommended parameters.

These are various algorithm settings which can control e.g. the amount of resource utilization.

Implementations

impl Params

pub fn new(mode: Mode, n: u64, r: u32, p: u32) -> Result<Params>

Initialize params.

Accepts the following arguments:

• mode: most users will want Mode::default. See the Mode type for more info.
• n: CPU/memory cost. See Params::n for more info.
• r: resource usage. See Params::r for more info.
• p: parallelization. See Params::p for more info.

pub fn new_with_all_params( mode: Mode, n: u64, r: u32, p: u32, t: u32, g: u32, ) -> Result<Params>

Initialize params including additional yescrypt-specific settings.

Accepts all the same arguments as Params::new with the following additional arguments:

• t: increase computation time while keeping peak memory usage the same. 0 is optimal.
• g: number of cost upgrades performed on the hash so far. 0 is the only allowed value.

pub const fn n(&self) -> u64

N: CPU/memory cost (like scrypt).

Memory and CPU usage scale linearly with N.

pub const fn r(&self) -> u32

r parameter: resource usage (like scrypt).

Memory and CPU usage scales linearly with this parameter.

pub const fn p(&self) -> u32

p parameter: parallelization (like scrypt).

Allows use of multithreaded parallelism (not currently implemented, 1 is the recommended setting for now).

Trait Implementations

impl Clone for Params

fn clone(&self) -> Params

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Params

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

Formats the value using the given formatter.

impl Default for Params

fn default() -> Self

Returns the “default value” for a type.

impl Display for Params

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

Formats the value using the given formatter.

impl FromStr for Params

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Params>

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

impl PartialEq for Params

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

impl Eq for Params

impl StructuralPartialEq for Params