Enum GithubAppError 

pub enum GithubAppError {
    NotConfigured,
    InvalidKey,
    InvalidHeader,
    ForeignOrigin,
    Http(HttpError),
    Status {
        status: StatusCode,
        rate_limit: RateLimit,
    },
    Decode(String),
    OAuth(String),
}

Everything that can go wrong. Every message this crate builds carries no token, client secret, JWT or part of the private key — with one exception, GithubAppError::Decode, which carries the JSON parser’s own words.

Variants

NotConfigured

No private key was configured, so there is nothing to sign with.

InvalidKey

A private key was configured but did not parse. The underlying parser message is deliberately not carried.

InvalidHeader

A value could not be put on the wire as an HTTP header.

ForeignOrigin

GithubApp::request was asked to send the installation token to a URI outside the API base’s origin (scheme, host and port). Nothing was minted or sent.

Http(HttpError)

The transport failed.

Status

GitHub answered a token or API call with a non-success status.

Fields

status: StatusCode

The status GitHub returned.

rate_limit: RateLimit

The rate-limit headers that came with it.

Decode(String)

A body could not be read. The detail is the JSON parser’s own message (a field name and a position), and a parser that meets an unexpected value may quote it — so this is diagnostic text, not a guarantee that no part of the body appears. It is never logged by this crate; a caller that prints it is printing something a response chose.

OAuth(String)

GitHub’s OAuth endpoint reported an error. Carries GitHub’s error code only.

Trait Implementations

impl Debug for GithubAppError

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

Formats the value using the given formatter.

impl Display for GithubAppError

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

Formats the value using the given formatter.

impl Error for GithubAppError

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<HttpError> for GithubAppError

fn from(source: HttpError) -> Self

Converts to this type from the input type.