Struct Finding 

pub struct Finding {
    pub id: &'static str,
    pub severity: Severity,
    pub path: Path,
    pub message: String,
    pub detail: Option<String>,
    pub hint: Option<String>,
}

One rule hit at a Path.

Fields

id: &'static str

Registered rule id (BR-02, PINT-TAX).

severity: Severity

Fatal fails Report::ok; Warning and Info do not.

path: Path

Finding location (Path; index is 0-based).

message: String

Authority wording. Arithmetic expected/actual belongs in Self::detail.

detail: Option<String>

Optional expected/actual. Not appended to Self::message by constructors.

hint: Option<String>

Optional hint. Not shown by Display.

Implementations

impl Finding

pub fn fatal(id: &'static str, path: Path, message: impl Into<String>) -> Self

Fatal finding. Fails Report::ok.

pub fn warning(id: &'static str, path: Path, message: impl Into<String>) -> Self

Warning finding. Does not fail Report::ok.

pub fn info(id: &'static str, path: Path, message: impl Into<String>) -> Self

Info finding. Does not fail Report::ok.

Trait Implementations

impl Clone for Finding

fn clone(&self) -> Finding

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 Display 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: &Finding) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Finding