Struct FileContentMatchesRule 

pub struct FileContentMatchesRule { /* private fields */ }

Trait Implementations

impl Debug for FileContentMatchesRule

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

Formats the value using the given formatter.

impl PerFileRule for FileContentMatchesRule

fn path_scope(&self) -> &Scope

The rule’s scope. The engine checks path_scope().matches(path) before calling evaluate_file; a rule that returns Scope::match_all is in scope for every file.

fn evaluate_file( &self, _ctx: &Context<'_>, path: &Path, bytes: &[u8], ) -> Result<Vec<Violation>>

Evaluate one file given the engine’s already-read byte content. The path is the relative path from the lint root; the rule should with_path(path.into()) (or clone the matched FileEntry::path if it has one in hand) on emitted violations.

fn max_bytes_needed(&self) -> Option<usize>

Optional lower bound on the bytes the rule needs to evaluate. Default None means “I need the whole file.” Used as a hint; the engine in v0.9.3 reads the whole file regardless and hands it to every applicable rule — the hint is reserved for a future engine-side bounded- read optimisation.

impl Rule for FileContentMatchesRule

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 as_per_file(&self) -> Option<&dyn PerFileRule>

Opt into the file-major dispatch path. Per-file rules that can evaluate one file at a time given a pre-loaded byte slice override this to return Some(self); cross-file rules and any rule with requires_full_index() == true leave it as None and keep evaluating under the rule- major loop.

fn git_tracked_mode(&self) -> GitTrackedMode

Whether (and how) this rule narrows its iteration to git-tracked entries. Default GitTrackedMode::Off. Rule kinds that support git_tracked_only: override to return GitTrackedMode::FileOnly (file-mode rules: check set.contains(path)) or GitTrackedMode::DirAware (dir-mode rules: check dir_has_tracked_files(path, set)) when the user opts in.

fn wants_git_blame(&self) -> bool

Whether this rule needs git blame output on Context. Default false; the git_blame_age rule kind overrides to return true. The engine builds the shared crate::git::BlameCache once per run when any rule opts in, so multiple blame-aware rules over overlapping paths: re-use the parsed result.

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.