Enum AuthError 

pub enum AuthError {
    InvalidCredentials,
    InstallationNotFound {
        installation_id: InstallationId,
    },
    TokenExpired,
    InsufficientPermissions {
        permission: String,
    },
    InvalidPrivateKey {
        message: String,
    },
    JwtGenerationFailed {
        message: String,
    },
    TokenGenerationFailed {
        message: String,
    },
    TokenExchangeFailed {
        installation_id: InstallationId,
        message: String,
    },
    GitHubApiError {
        status: u16,
        message: String,
    },
    SigningError(SigningError),
    SecretError(SecretError),
    CacheError(CacheError),
    NetworkError(String),
    ApiError(ApiError),
}

Authentication-related errors with retry classification.

This error type covers all authentication failures including credential issues, token expiration, and GitHub API errors. Each variant includes metadata to support intelligent retry logic and detailed error reporting.

Variants

InvalidCredentials

Invalid GitHub App credentials (non-retryable).

InstallationNotFound

Installation not found or access denied (non-retryable).

Fields

installation_id: InstallationId

TokenExpired

Installation token has expired (retryable via refresh).

InsufficientPermissions

Insufficient permissions for the requested operation (non-retryable).

Fields

permission: String

InvalidPrivateKey

Invalid private key format or data (non-retryable).

Fields

message: String

JwtGenerationFailed

JWT generation failed (non-retryable).

Fields

message: String

TokenGenerationFailed

Token generation failed (non-retryable).

Fields

message: String

TokenExchangeFailed

Token exchange with GitHub API failed.

Fields

installation_id: InstallationId

message: String

GitHubApiError

GitHub API returned an error response.

Fields

status: u16

message: String

SigningError(SigningError)

JWT signing operation failed.

SecretError(SecretError)

Secret retrieval from secure storage failed.

CacheError(CacheError)

Token cache operation failed.

NetworkError(String)

Network connectivity or transport error.

ApiError(ApiError)

GitHub API client error.

Implementations

impl AuthError

pub fn is_transient(&self) -> bool

Check if this error represents a transient condition that may succeed if retried.

Transient errors include:

• Network failures
• Server errors (5xx)
• Rate limiting (429)
• Token expiration (can refresh)
• Cache failures (can regenerate)

Non-transient errors include:

• Invalid credentials
• Missing installations
• Insufficient permissions
• Client errors (4xx except 429)

pub fn should_retry(&self) -> bool

Determine if this error should trigger a retry attempt.

Alias for is_transient() to support different retry policy conventions.

pub fn retry_after(&self) -> Option<Duration>

Get the recommended retry delay for this error.

Returns Some(Duration) if a specific delay is recommended (e.g., rate limiting), or None to use the default exponential backoff policy.

Trait Implementations

impl Debug for AuthError

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

Formats the value using the given formatter.

impl Display for AuthError

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

Formats the value using the given formatter.

impl Error for AuthError

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<ApiError> for AuthError

fn from(source: ApiError) -> Self

Converts to this type from the input type.

impl From<CacheError> for AuthError

fn from(source: CacheError) -> Self

Converts to this type from the input type.

impl From<SecretError> for AuthError

fn from(source: SecretError) -> Self

Converts to this type from the input type.

impl From<SigningError> for AuthError

fn from(source: SigningError) -> Self

Converts to this type from the input type.