Struct cargo_culture_kit::BuildsCleanlyWithoutWarningsOrErrors

pub struct BuildsCleanlyWithoutWarningsOrErrors;

Rule that asserts a good Rust project: "Should cargo clean and cargo build without any warnings or errors."

Justification

A Rust project striving for excellence and accessibility should be able to be built "out of the box" with common tooling and do so without any superfluous warnings or build errors. The clean step is necessary to get complete error/warning messages repeatably.

While not every warning is appropriate to be absent from every project, developers have the ability to thoughtfully silence warnings that are not relevant to the present use case.

Caveats

Though this rule makes an effort to avoid needless work by targeting the cargo clean invocations to the project's own packages, unless dependencies have been previously built, evaluate is likely to take a while.

Trait Implementations

impl Debug for BuildsCleanlyWithoutWarningsOrErrors

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

Formats the value using the given formatter.

impl Default for BuildsCleanlyWithoutWarningsOrErrors

fn default() -> BuildsCleanlyWithoutWarningsOrErrors

Returns the "default value" for a type.

impl Rule for BuildsCleanlyWithoutWarningsOrErrors

fn description(&self) -> &'static str

The central tenet of this Rule. Serves as a unique identifier for Rule instances, as well as a human-readable summary of what this Rule means for a given project.

fn evaluate(&self, context: RuleContext) -> RuleOutcome

Does the Rust project found at cargo_manifest_path uphold this Rule, as summarized in the description?