Enum OAuth2Error 

pub enum OAuth2Error {
    ConfigMissing {
        field: &'static str,
    },
    InvalidUrl {
        field: &'static str,
        reason: String,
    },
    CookieTemplateInvalid {
        which: OAuth2CookieKind,
        reason: String,
    },
    MissingStateCookie,
    MissingPkceCookie,
    ProviderReturnedError {
        error: String,
        description: Option<String>,
    },
    StateMismatch,
    MissingAuthorizationCode,
    TokenExchange {
        message: String,
    },
    AccountMapping {
        message: String,
    },
    AccountPersistence {
        message: String,
    },
    JwtEncoding {
        message: String,
    },
    JwtNotUtf8,
}

OAuth2-specific error type for OAuth2Gate.

This enum intentionally uses string messages for external/foreign errors to keep this module decoupled from particular HTTP or OAuth client implementations. Prefer mapping concrete errors into one of these variants at the boundary layers.

Variants

ConfigMissing

A required configuration field is missing on the OAuth2Gate builder.

Fields

field: &'static str

Name of the missing field (e.g., “auth_url”, “token_url”, “client_id”, “redirect_url”).

InvalidUrl

A provided URL failed validation or parsing.

Fields

field: &'static str

Which URL field failed (e.g., “auth_url”, “token_url”, “redirect_url”).

reason: String

Reason or parser message (redacted for end users).

CookieTemplateInvalid

A cookie template used by the OAuth2 flow failed validation.

Fields

which: OAuth2CookieKind

Which cookie template failed validation (state, pkce, or auth).

reason: String

Reason or validator message (redacted for end users).

MissingStateCookie

Required state cookie is missing at callback time.

MissingPkceCookie

Required PKCE cookie is missing at callback time.

ProviderReturnedError

Provider returned an error to the callback endpoint.

Fields

error: String

Provider error identifier.

description: Option<String>

Optional provider-supplied description.

StateMismatch

The state parameter from the provider did not match the stored cookie.

MissingAuthorizationCode

The provider callback did not include an authorization code.

TokenExchange

Token exchange with the provider failed.

Fields

message: String

Failure message (e.g., request or response parsing reason).

AccountMapping

Mapping the provider token response to a domain Account failed.

Fields

message: String

Failure message (e.g., userinfo retrieval/mapping reason).

AccountPersistence

Persisting or loading the account prior to JWT issuance failed.

Fields

message: String

Failure message (e.g., repository/backend reason).

JwtEncoding

Encoding the first‑party JWT failed.

Fields

message: String

Failure message (e.g., codec/serialization reason).

JwtNotUtf8

The JWT produced by the encoder was not valid UTF‑8.

Implementations

impl OAuth2Error

pub fn missing(field: &'static str) -> Self

Helper to construct a ConfigMissing error.

pub fn invalid_url(field: &'static str, reason: impl Into<String>) -> Self

Helper to construct an InvalidUrl error.

pub fn cookie_invalid( which: OAuth2CookieKind, reason: impl Into<String>, ) -> Self

Helper to construct a CookieTemplateInvalid error.

pub fn provider_error( error: impl Into<String>, description: Option<String>, ) -> Self

Helper to construct a ProviderReturnedError error.

pub fn token_exchange(message: impl Into<String>) -> Self

Helper to construct a TokenExchange error.

pub fn account_mapping(message: impl Into<String>) -> Self

Helper to construct an AccountMapping error.

pub fn account_persistence(message: impl Into<String>) -> Self

Helper to construct an AccountPersistence error.

pub fn jwt_encoding(message: impl Into<String>) -> Self

Helper to construct a JwtEncoding error.

Trait Implementations

impl Debug for OAuth2Error

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

Formats the value using the given formatter.

impl Display for OAuth2Error

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

Formats the value using the given formatter.

impl Error for OAuth2Error

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

fn from(source: OAuth2Error) -> Self

Converts to this type from the input type.

impl UserFriendlyError for OAuth2Error

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.