Enum HashingError 

#[non_exhaustive]
pub enum HashingError {
    Operation {
        operation: HashingOperation,
        message: String,
        algorithm: Option<String>,
        expected_format: Option<String>,
    },
}

Error returned by hashing services and verification flows.

Use this type when hashing or verification cannot be completed safely.

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.

Operation

A hashing-related operation failed.

Fields

operation: HashingOperation

The hashing operation that failed.

message: String

Description of the error (non-sensitive).

algorithm: Option<String>

The hashing algorithm used (e.g., argon2id, bcrypt) if known.

expected_format: Option<String>

Expected hash format (sanitized) if relevant.

Implementations

impl HashingError

pub fn new(operation: HashingOperation, message: impl Into<String>) -> Self

Creates a hashing error without algorithm or format context.

Examples

use webgates_secrets::hashing::errors::{HashingError, HashingOperation};
let _err = HashingError::new(HashingOperation::Hash, "failed to hash value");

pub fn with_algorithm( operation: HashingOperation, message: impl Into<String>, algorithm: impl Into<String>, ) -> Self

Creates a hashing error with algorithm context.

Examples

use webgates_secrets::hashing::errors::{HashingError, HashingOperation};
let _err = HashingError::with_algorithm(HashingOperation::Verify, "verification failed", "argon2id");

pub fn with_context( operation: HashingOperation, message: impl Into<String>, algorithm: Option<String>, expected_format: Option<String>, ) -> Self

Creates a hashing error with full context.

Examples

use webgates_secrets::hashing::errors::{HashingError, HashingOperation};
let _err = HashingError::with_context(
    HashingOperation::Verify,
    "verification failed",
    Some("argon2id".into()),
    Some("$argon2id$v=19$...".into()),
);

Trait Implementations

impl Debug for HashingError

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

Formats the value using the given formatter.

impl Display for HashingError

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

Formats the value using the given formatter.

impl Error for HashingError

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 UserFriendlyError for HashingError

fn user_message(&self) -> String

User-facing message that is clear, actionable, and non-technical.

fn developer_message(&self) -> String

Technical message with detailed information for developers and logs.

fn support_code(&self) -> String

Unique support reference code for customer service and troubleshooting.

fn severity(&self) -> ErrorSeverity

Error severity level for proper handling and alerting.

fn suggested_actions(&self) -> Vec<String>

Suggested user actions for resolving the error (optional).

fn is_retryable(&self) -> bool

Whether this error should be retryable by the user (default: false).