Struct Check 

pub struct Check {
    pub name: String,
    pub status: Status,
    pub detail: String,
    pub fix: Option<String>,
}

One thing that was checked, and what to do when it is wrong.

Fields

name: String

What was checked, e.g. git or node reachable.

status: Status

How it came out.

detail: String

What was found: a path, a version, an error, an http status.

fix: Option<String>

The command that fixes it, when there is one to name.

None for a passing check and for a failure whose fix depends on something this process cannot know. A wrong fix is worse than no fix: it gets run.

Implementations

impl Check

pub fn pass(name: &str, detail: impl Into<String>) -> Check

A passing check.

pub fn warn(name: &str, detail: impl Into<String>) -> Check

A degraded-but-working check.

pub fn fail(name: &str, detail: impl Into<String>) -> Check

A check that failed.

pub fn with_fix(self, fix: impl Into<String>) -> Check

Attaches the command that fixes this check.

Trait Implementations

impl Clone for Check

fn clone(&self) -> Check

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Check

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

Formats the value using the given formatter.