Enum Stance 

pub enum Stance {
    Applies,
    NotApplicable(String),
    Excluded(String),
    Redundant {
        reason: String,
        inapplicable: String,
    },
}

Where one step stands at this target, before anything runs.

Applicability is the profile’s answer and carries no operator reason; an exclusion is the operator’s own statement about a step that does apply. An exclusion declared for a step that does not apply is redundant: it is reported as such and turns the step into no work.

SATISFIES forge-setup:applicability-follows-the-target-configuration

Variants

Applies

The step applies and the run acts on it.

NotApplicable(String)

The target configuration does not select it, with the value that decided so.

Excluded(String)

The target declared it does not run it, with its stated reason.

Redundant

The target excluded a step that does not apply here.

Fields

reason: String

The reason the target stated.

inapplicable: String

Why the step does not apply either way.

Implementations

impl Stance

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

The word a report and an event use.

pub const fn acts(&self) -> bool

Whether the run acts on the step.

pub fn detail(&self) -> String

The reason alone, as an event and a check line carry it.

pub fn framed(&self) -> String

The same, framed by what decided it, as a preview and an apply name it.

Trait Implementations

impl Clone for Stance

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Stance

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

Formats the value using the given formatter.