Enum PollPace 

pub enum PollPace {
    Nominal,
    RateLimited {
        kind: RateLimitKind,
    },
    LockedOut,
    Offline {
        consecutive: u32,
    },
    Blocked,
}

Why the next poll is when it is.

Reported rather than inferred, because 04-subsystem-contracts.md requires that rate limiting be “displayed, never hidden” — and a delay that grew for a reason the caller cannot name is hidden however visible the number is.

Variants

Nominal

The configured interval. Nothing is throttling this loop.

RateLimited

GitHub’s rate limit is exhausted. Resolves by waiting.

Fields

kind: RateLimitKind

LockedOut

GitHub’s temporary authentication lockout. The credential is fine.

Offline

GitHub could not be reached. consecutive counts the unbroken run of failures the back-off was computed from.

Fields

consecutive: u32

Blocked

GitHub answered something no amount of waiting fixes — a rejected credential, a permissions refusal, or an error status. The loop keeps polling at its nominal interval so that a fix is noticed, and says that it is blocked rather than pretending the poll succeeded.

Implementations

impl PollPace

pub const fn is_throttled(&self) -> bool

Whether this pace is a slowdown the operator should be told about.

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

A fixed, credential-free name for the log sink and for g2.

Trait Implementations

impl Clone for PollPace

fn clone(&self) -> PollPace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PollPace

impl Debug for PollPace

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

Formats the value using the given formatter.

impl Display for PollPace

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

Formats the value using the given formatter.

impl Eq for PollPace

impl PartialEq for PollPace

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PollPace