Struct FileHeaderRule 

pub struct FileHeaderRule { /* private fields */ }

Trait Implementations

impl Debug for FileHeaderRule

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

Formats the value using the given formatter.

impl Rule for FileHeaderRule

fn id(&self) -> &str

fn level(&self) -> Level

fn policy_url(&self) -> Option<&str>

fn fixer(&self) -> Option<&dyn Fixer>

Optional automatic-fix strategy. Rules whose violations can be mechanically corrected (e.g. creating a missing file, removing a forbidden one, renaming to the correct case) return a Fixer here; the default implementation reports the rule as unfixable.

fn evaluate(&self, ctx: &Context<'_>) -> Result<Vec<Violation>>

fn wants_git_tracked(&self) -> bool

Whether this rule needs the git-tracked-paths set on Context. Default false; rule kinds that support git_tracked_only override to return true only when the user actually opted in. The engine collects the set (via git ls-files) once per run when ANY rule returns true, so the cost is paid at most once even if many rules opt in.

fn requires_full_index(&self) -> bool

In --changed mode, return true to evaluate this rule against the full FileIndex rather than the changed-only filtered subset. Default false (per-file semantics — the rule sees only changed files in scope).

fn path_scope(&self) -> Option<&Scope>

In --changed mode, return the Scope this rule is scoped to (typically the rule’s paths: field). The engine intersects the scope with the changed-set; rules whose scope doesn’t intersect are skipped, which is the optimisation --changed exists for.