Enum password_hash::errors::Error

#[non_exhaustive]
pub enum Error {
    Algorithm,
    B64Encoding(B64Error),
    Crypto,
    OutputSize {
        provided: Ordering,
        expected: usize,
    },
    ParamNameDuplicated,
    ParamNameInvalid,
    ParamValueInvalid(InvalidValue),
    ParamsMaxExceeded,
    Password,
    PhcStringField,
    PhcStringTrailingData,
    SaltInvalid(InvalidValue),
    Version,
}

Password hashing errors.

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.

Algorithm

Unsupported algorithm.

B64Encoding(B64Error)

“B64” encoding error.

Crypto

Cryptographic error.

OutputSize

Output size unexpected.

Fields

provided: Ordering

Indicates why the output size is unexpected.

• Ordering::Less: Size is too small.
• Ordering::Equal: Size is not exactly as expected.
• Ordering::Greater: Size is too long.

expected: usize

Expected output size in relation to provided.

• Ordering::Less: Minimum size.
• Ordering::Equal: Expecrted size.
• Ordering::Greater: Maximum size.

ParamNameDuplicated

Duplicate parameter name encountered.

ParamNameInvalid

Invalid parameter name.

ParamValueInvalid(InvalidValue)

Invalid parameter value.

ParamsMaxExceeded

Maximum number of parameters exceeded.

Password

Invalid password.

PhcStringField

Password hash string invalid.

PhcStringTrailingData

Password hash string contains trailing data.

SaltInvalid(InvalidValue)

Salt invalid.

Version

Invalid algorithm version.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

Available on crate feature std only.

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 From<Error> for Error

fn from(err: B64Error) -> Error

Converts to this type from the input type.

impl From<InvalidLengthError> for Error

fn from(_: InvalidLengthError) -> Error

Converts to this type from the input type.

impl PartialEq for Error

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

impl Eq for Error

impl StructuralPartialEq for Error