Enum ForgeError 

pub enum ForgeError {
    Transport(TransportError),
    Unprocessable {
        request: RequestLabel,
        body: RejectionBody,
    },
    CapabilityUnavailable {
        request: RequestLabel,
    },
    Config(ConfigError),
    OwnAppBypassWithoutApp {
        ruleset: RulesetName,
    },
    RuleDecode {
        ruleset: String,
        source: Box<ValueError>,
    },
    RuleParametersDecode {
        ruleset: String,
        rule: String,
        source: Box<ValueError>,
    },
    InvitationRoleUnsupported,
    AmbiguousPullRequest {
        head: String,
        base: String,
    },
    InvalidAssetFilename {
        filename: String,
    },
    ReleaseImmutable {
        id: u64,
    },
    InvalidUploadUrl {
        id: u64,
        template: String,
    },
    EmptyCallerLogin(EmptyUserName),
}

Anything that stops a GitHub request from producing a usable answer.

Variants

Transport(TransportError)

Transport trouble: unreachable, a bad credential, a missing resource, a rate limit, a rejected body, or a body this build cannot read.

Unprocessable

GitHub answered 422: it read the request and found it invalid.

Fields

request: RequestLabel

The method and path that were attempted.

body: RejectionBody

What GitHub answered with.

CapabilityUnavailable

The repository or plan lacks the capability the route needs (for example, repository rulesets).

Fields

request: RequestLabel

The method and path that were attempted.

Config(ConfigError)

The configuration has a value GitHub would refuse.

OwnAppBypassWithoutApp

A ruleset lets the acting App bypass it, but the caller is not an App.

Fields

ruleset: RulesetName

The ruleset’s name.

RuleDecode

A rule in a live ruleset has no readable type.

Fields

ruleset: String

The ruleset’s name.

source: Box<ValueError>

Why the rule did not decode.

RuleParametersDecode

The parameters of a rule in a live ruleset do not decode.

Fields

ruleset: String

The ruleset’s name.

rule: String

The rule’s type.

source: Box<ValueError>

Why the parameters did not decode.

InvitationRoleUnsupported

A pending invitation cannot be changed to a custom role.

AmbiguousPullRequest

More than one open pull request matched the proposal’s head and base.

Fields

head: String

The proposal’s head branch.

base: String

The proposal’s base branch.

InvalidAssetFilename

A release asset filename cannot address a safe upload path.

Fields

filename: String

The rejected filename.

ReleaseImmutable

The release is already published, so it is immutable.

Fields

id: u64

The release’s id.

InvalidUploadUrl

The release’s upload URL template does not parse as a URL.

Fields

id: u64

The release’s id.

template: String

The upload URL template GitHub answered with.

EmptyCallerLogin(EmptyUserName)

The forge answered the current user request with an empty login.

Implementations

impl ForgeError

pub fn status(&self) -> Option<u16>

The HTTP status of a failure that carries one.

Trait Implementations

impl Debug for ForgeError

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

Formats the value using the given formatter.

impl Display for ForgeError

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

Formats the value using the given formatter.

impl Error for ForgeError

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<ConfigError> for ForgeError

fn from(source: ConfigError) -> Self

Converts to this type from the input type.

impl From<EmptyUserName> for ForgeError

fn from(source: EmptyUserName) -> Self

Converts to this type from the input type.

impl From<TransportError> for ForgeError

fn from(error: TransportError) -> Self

Converts to this type from the input type.