Trait cargo_culture_kit::rules::Rule

pub trait Rule: Debug {
    fn description(&self) -> &str;
    fn evaluate(&self, context: RuleContext) -> RuleOutcome;
}

The core trait of this crate. A Rule describes an idiom or best-practice for projects and provides a means of evaluating whether that rule of thumb is being upheld.

Required Methods

fn description(&self) -> &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?

Implementors

• impl Rule for BuildsCleanlyWithoutWarningsOrErrors

• impl Rule for CargoMetadataReadable

• impl Rule for HasContinuousIntegrationFile

• impl Rule for HasContributingFile

• impl Rule for HasLicenseFile

• impl Rule for HasReadmeFile

• impl Rule for HasRustfmtFile

• impl Rule for PassesMultipleTests

• impl Rule for UnderSourceControl

• impl Rule for UsesPropertyBasedTestLibrary