Enum CheckBucket 

#[non_exhaustive]
pub enum CheckBucket {
    Pass,
    Fail,
    Pending,
    Skipping,
    Cancel,
    Unknown,
}

gh’s coarse categorisation of a CheckRun’s state — the field to branch on when deciding whether CI passed. gh derives it from the raw state; this is the typed form of its pass/fail/pending/skipping/cancel strings.

#[non_exhaustive] with an Unknown catch-all: a bucket name a future gh introduces (or a missing field) deserialises to Unknown rather than failing the parse, so the wrapper never breaks on an unmodelled value.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Pass

The check succeeded.

Fail

The check failed.

Pending

The check is queued or still running.

Skipping

The check was skipped (e.g. a conditional job that didn’t run).

Cancel

The check was cancelled.

Unknown

A bucket gh reported that this version doesn’t model, or an absent field.

Implementations

impl CheckBucket

pub fn is_failing(self) -> bool

Whether this bucket means the check failed or was cancelled — the states that should fail an aggregate CI verdict.

pub fn is_pending(self) -> bool

Whether this bucket means the check is still in flight (queued/running).

pub fn is_passing(self) -> bool

Whether this bucket means the check completed successfully.

pub fn is_unknown(self) -> bool

Whether this is the Unknown catch-all — a bucket a future gh introduced (or a missing field) that this version doesn’t model. Distinct from Skipping: a skip is a deliberate, terminal no-op, whereas an unknown bucket is unclassified and should be treated conservatively (as “not known to be done”) by an aggregator.

Trait Implementations

impl Clone for CheckBucket

fn clone(&self) -> CheckBucket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CheckBucket

impl Debug for CheckBucket

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

Formats the value using the given formatter.

impl Default for CheckBucket

fn default() -> CheckBucket

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CheckBucket

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CheckBucket

impl PartialEq for CheckBucket

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CheckBucket