Enum FormatOutcome 

pub enum FormatOutcome {
    Clean,
    Formatted,
    Skipped(String),
    Failed(String),
}

Outcome of a per-language format step.

Variants

Clean

The formatter ran and made no changes (or found no issues in --check).

Formatted

The formatter ran and either rewrote files or — in --check — found issues. Returns the original stderr (if any) for reporting.

Skipped(String)

Skipped: either no matching files or the required tool isn’t installed.

Failed(String)

Formatter exited with a non-zero status unexpectedly.

Implementations

impl FormatOutcome

pub fn passed(&self) -> bool

true iff the step should be treated as a pass for pre-commit gating.

Trait Implementations

impl Debug for FormatOutcome

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

Formats the value using the given formatter.

impl PartialEq for FormatOutcome

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

impl StructuralPartialEq for FormatOutcome