Struct Finding 

pub struct Finding {
    pub check: &'static str,
    pub file: String,
    pub line: Option<usize>,
    pub column: Option<usize>,
    pub severity: Severity,
    pub message: String,
}

A single problem, addressable.

Fields

check: &'static str

The check’s short name — ban-terms, not pre-commit-ban-terms. The stage is not a property of the finding: the same content problem is the same problem whichever hook noticed it, and an editor has no stages.

file: String

Repository-relative, as git spells it.

line: Option<usize>

1-based, as every editor and terminal counts. None when the finding is about the file as a whole.

column: Option<usize>

1-based, counted in CHARACTERS rather than bytes — see line_col.

severity: Severity

message: String

One line, no trailing period, safe to print. Anything derived from file content must be sanitised by its producer before it gets here: this type will happily print whatever it is given, and secrets in particular must never put the matched text in it.

Implementations

impl Finding

pub fn new( check: &'static str, file: impl Into<String>, severity: Severity, message: impl Into<String>, ) -> Self

pub fn at_offset(self, content: &str, offset: usize) -> Self

Place this finding at a byte offset within content.

pub fn at_line(self, line: usize) -> Self

Place it on a line whose column is not known or not meaningful.

pub fn location(&self) -> String

file:line:col — just the address.

Used inside a hook’s own report, which already says which check spoke and how loudly; repeating either there would be noise. render is the form for anything outside amont.

pub fn render(&self) -> String

file:line:col: severity: message [check]

The shape every editor’s error parser already understands, and which every modern terminal turns into a clickable link. That is the whole reason for choosing it over something prettier: it needs no adapter.

Trait Implementations

impl Clone for Finding

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Finding

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

Formats the value using the given formatter.

impl Eq for Finding

impl PartialEq for Finding

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Finding