Struct YamlRule 

pub struct YamlRule { /* private fields */ }

A rule loaded from a YAML definition file. Implements the Rule trait so it can be added to a RuleSet.

Implementations

impl YamlRule

pub fn new(def: YamlRuleDef) -> Result<Self, YamlRuleError>

Create a YamlRule from a validated definition.

pub fn from_yaml(yaml: &str) -> Result<Self, YamlRuleError>

Parse a YAML string into a YamlRule.

pub fn from_yaml_multi(yaml: &str) -> (Vec<Self>, Vec<YamlRuleError>)

Parse a YAML file containing multiple rule definitions. Returns all valid rules and any errors encountered.

pub fn definition(&self) -> &YamlRuleDef

Get the underlying definition.

Trait Implementations

impl Clone for YamlRule

fn clone(&self) -> YamlRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for YamlRule

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

Formats the value using the given formatter.

impl Rule for YamlRule

fn id(&self) -> &str

Unique identifier for this rule (e.g. “freshness/stale-doc”).

fn name(&self) -> &str

Human-readable name.

fn description(&self) -> &str

Short description of what this rule checks.

fn category(&self) -> RuleCategory

Category this rule belongs to.

fn default_severity(&self) -> Severity

Default severity when the rule is violated.

fn evaluate( &self, ctx: &RuleContext<'_>, _config: &RuleConfig, ) -> Vec<RuleViolation>

Evaluate the rule against the project context. Returns zero or more violations.