Struct cargo_culture_kit::CargoMetadataReadable

pub struct CargoMetadataReadable;

Rule that asserts a good Rust project: "Should have a well-formed Cargo.toml file readable by cargo metadata"

Justification

Cargo is the Rust community-wide standard tool for managing Rust projects and packages. An invalid or absent Cargo.toml file suggests the use of a nonstandard build methodology, or some accident of misconfiguration.

Trait Implementations

impl Default for CargoMetadataReadable

fn default() -> CargoMetadataReadable

Returns the "default value" for a type.

impl Debug for CargoMetadataReadable

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

Formats the value using the given formatter.

impl Rule for CargoMetadataReadable

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

Due to the layout of Rule execution wherein cargo metadata is read and parsed as part of check_culture and then handed off to the Rules being checked, evaluate will declare a success if the metadata parameter is Some.