Struct scrypt::Params

pub struct Params { /* private fields */ }

The Scrypt parameter values.

Implementations

impl Params

pub const RECOMMENDED_LOG_N: u8 = 17u8

Recommended log₂ of the Scrypt parameter N: CPU/memory cost.

pub const RECOMMENDED_R: u32 = 8u32

Recommended Scrypt parameter r: block size.

pub const RECOMMENDED_P: u32 = 1u32

Recommended Scrypt parameter p: parallelism.

pub const RECOMMENDED_LEN: usize = 32usize

Recommended Scrypt parameter Key length.

pub fn new(log_n: u8, r: u32, p: u32, len: usize) -> Result<Params, InvalidParams>

Create a new instance of Params.

Arguments

• log_n - The log₂ of the Scrypt parameter N
• r - The Scrypt parameter r
• p - The Scrypt parameter p
• len - The Scrypt parameter Key length

Conditions

• log_n must be less than 64
• r must be greater than 0 and less than or equal to 4294967295
• p must be greater than 0 and less than 4294967295
• len must be greater than 9 and less than or equal to 64

pub fn recommended() -> Params

Recommended values sufficient for most use-cases

• log_n = 15 (n = 32768)
• r = 8
• p = 1

pub fn log_n(&self) -> u8

log₂ of the Scrypt parameter N, the work factor.

Memory and CPU usage scale linearly with N.

pub fn r(&self) -> u32

r parameter: resource usage.

scrypt iterates 2*r times. Memory and CPU time scale linearly with this parameter.

pub fn p(&self) -> u32

p parameter: parallelization.

Trait Implementations

impl Clone for Params

fn clone(&self) -> Params

Returns a copy 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() -> Params

Returns the “default value” for a type.

impl<'a> TryFrom<&'a PasswordHash<'a>> for Params

Available on crate feature simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(hash: &'a PasswordHash<'a>) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<Params> for ParamsString

Available on crate feature simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(input: Params) -> Result<ParamsString, Error>

Performs the conversion.

impl Copy for Params