Enum ApiError 

pub enum ApiError {
    HttpError {
        status: u16,
        message: String,
    },
    RateLimitExceeded {
        reset_at: DateTime<Utc>,
    },
    SecondaryRateLimit,
    Timeout,
    InvalidRequest {
        message: String,
    },
    AuthenticationFailed,
    AuthorizationFailed,
    NotFound,
    JsonError(Error),
    HttpClientError(Error),
    Configuration {
        message: String,
    },
    TokenGenerationFailed {
        message: String,
    },
    TokenExchangeFailed {
        message: String,
    },
    GraphQlError {
        message: String,
    },
}

Errors during GitHub API operations.

These errors represent failures when communicating with the GitHub API, including HTTP errors, rate limiting, and parsing failures.

Variants

HttpError

HTTP error response from GitHub API.

Fields

status: u16

message: String

RateLimitExceeded

Rate limit exceeded. Operations should wait until reset time.

Fields

reset_at: DateTime<Utc>

SecondaryRateLimit

Secondary rate limit (abuse detection) exceeded. Requires longer backoff period than primary rate limits.

Timeout

Request to GitHub API timed out.

InvalidRequest

The request was invalid (client error).

Fields

message: String

AuthenticationFailed

Authentication to GitHub API failed.

AuthorizationFailed

Authorization check failed (insufficient permissions).

NotFound

The requested resource was not found.

JsonError(Error)

Failed to parse JSON response from GitHub API.

HttpClientError(Error)

HTTP client error (network, TLS, etc.).

Configuration

Client configuration error.

Fields

message: String

TokenGenerationFailed

Failed to generate authentication token.

Fields

message: String

TokenExchangeFailed

Failed to exchange token.

Fields

message: String

GraphQlError

GraphQL API returned an application-level error.

GitHub’s GraphQL endpoint always returns HTTP 200; errors are reported inside the response body under .errors[].message. This variant captures the first such message. It is non-retryable because it indicates a logic error in the query or variables, not a transient infrastructure problem.

Fields

message: String

Implementations

impl ApiError

pub fn is_transient(&self) -> bool

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

Transient conditions include:

• Server errors (5xx)
• Rate limiting (429)
• Request timeouts
• Network/transport errors

Trait Implementations

impl Debug for ApiError

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

Formats the value using the given formatter.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

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

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiError

fn from(source: Error) -> Self

Converts to this type from the input type.