Enum Status 

pub enum Status {
    Pass,
    Warn,
    Fail,
}

How a single check came out.

Three states rather than two because the difference matters to the exit code: an absent mergiraf narrows the merge ladder to line merge and first-class conflicts, which is a worse node and a working one. Failing the command for it would teach operators to ignore the command.

Variants

Pass

Present and usable.

Warn

Usable, but something is degraded or unset.

Fail

Something that is required is absent or broken.

Implementations

impl Status

pub fn worst(checks: &[Check]) -> Status

The most severe status in a set, or Status::Pass for none.

This is what decides the exit code, so it is ordering over the enum rather than a hand-written match: adding a status variant between the existing ones must not silently keep the old answer.

pub fn label(self) -> &'static str

The fixed-width label used in the report, without colour.

Trait Implementations

impl Clone for Status

fn clone(&self) -> Status

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Status

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

Formats the value using the given formatter.

impl Ord for Status

fn cmp(&self, other: &Status) -> 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.

impl PartialEq for Status

fn eq(&self, other: &Status) -> 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 PartialOrd for Status

fn partial_cmp(&self, other: &Status) -> 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 Copy for Status

impl Eq for Status

impl StructuralPartialEq for Status