Enum AuthnError 

#[non_exhaustive]
pub enum AuthnError {
    Authentication {
        error: AuthenticationError,
        context: Option<String>,
    },
}

Category-native authentication error.

Wraps AuthenticationError and provides category-oriented constructors, user-friendly messaging, support codes, severity, and retryability.

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.

Authentication

Authentication flow failure (e.g., invalid credentials, expired session).

Fields

error: AuthenticationError

The specific authentication failure kind.

context: Option<String>

Optional context about where/how the failure occurred (non-sensitive).

Implementations

impl AuthnError

pub fn from_authentication( error: AuthenticationError, context: Option<String>, ) -> Self

Construct from a leaf AuthenticationError with optional context.

pub fn invalid_credentials(context: Option<String>) -> Self

Invalid credentials were provided.

Trait Implementations

impl Debug for AuthnError

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

Formats the value using the given formatter.

impl Display for AuthnError

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

Formats the value using the given formatter.

impl Error for AuthnError

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

fn from(source: AuthnError) -> Self

Converts to this type from the input type.

impl UserFriendlyError for AuthnError

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.

fn is_retryable(&self) -> bool

Whether this error should be retryable by the user.