Enum Outcome 

pub enum Outcome {
    Answered,
    Refused,
    RateLimited,
}

How one request ended.

Variants

Answered

GitHub answered with what was asked for.

Refused

GitHub did not answer it, for a reason that is not a rate limit — including a request that never reached GitHub at all, which carries no headers to read.

RateLimited

A rate limiter refused it, so it never ran.

Implementations

impl Outcome

pub fn of_response( status: StatusCode, budget_exhausted: bool, body: &str, ) -> Self

How a response ended, read the way this source’s own limiter reads one.

budget_exhausted is whether x-ratelimit-remaining was exactly 0, which explains a failing response rather than making a successful one fail. A GraphQL success carrying errors is a refusal only its caller can rule on, so this answers Outcome::Answered for one and the caller narrows it.

The status is a StatusCode rather than a number, so a status HTTP has no room for cannot be asked about at all — and an HTTP client has already parsed one for every response it hands back, so nothing is asked of a caller that it did not have.

pub const fn name(self) -> &'static str

This outcome’s name in a report.

Trait Implementations

impl Clone for Outcome

fn clone(&self) -> Outcome

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Outcome

impl Debug for Outcome

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

Formats the value using the given formatter.

impl Eq for Outcome

impl Hash for Outcome

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Outcome

fn cmp(&self, other: &Outcome) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Outcome

fn eq(&self, other: &Outcome) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for Outcome

fn partial_cmp(&self, other: &Outcome) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Outcome