Enum ScryptError 

#[non_exhaustive]
pub enum ScryptError {
    InvalidLogN,
    InvalidR,
    InvalidP,
    InvalidOutputLen,
    ResourceOverflow,
    AllocationFailed,
    EntropyUnavailable,
}

Available on (crate features hmac or hkdf or kmac or ed25519 or x25519 or phc-strings or argon2 or scrypt) and crate feature scrypt only.

Invalid scrypt parameter, input length, or resource constraint.

Surfaced at build or hash time — never at verify time (a parameter error during verification would leak information about the stored hash, so verify collapses these into crate::VerificationError).

Examples

use rscrypto::{ScryptParams, auth::scrypt::ScryptError};

assert_eq!(
  ScryptParams::new().log_n(0).build().unwrap_err(),
  ScryptError::InvalidLogN,
);

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.

InvalidLogN

log_n must be in 1..=63 (N must be a power of two greater than 1).

InvalidR

r must be at least 1.

InvalidP

p must be at least 1 and satisfy r · p ≤ 2^30 − 1.

InvalidOutputLen

output_len must be at least MIN_OUTPUT_LEN.

ResourceOverflow

The requested working-set size overflows the address space of the target. Typically means log_n is too large for a 32-bit target.

AllocationFailed

The allocator refused to provide the working-set buffers.

EntropyUnavailable

The platform entropy source failed while generating a PHC salt.

Trait Implementations

impl Clone for ScryptError

fn clone(&self) -> ScryptError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScryptError

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

Formats the value using the given formatter.

impl Display for ScryptError

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

Formats the value using the given formatter.

impl Error for ScryptError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl Hash for ScryptError

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 PartialEq for ScryptError

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

impl Eq for ScryptError

impl StructuralPartialEq for ScryptError