Struct FindingSpec 

pub struct FindingSpec {
    pub id: String,
    pub message: String,
    pub level: Option<FindingLevel>,
    pub pos: Option<SourcePos>,
    pub hint: Option<String>,
}

The input to Ctx::finding — id and message required, level/pos/hint optional.

Fields

id: String

the finding id, area/.../name

message: String

what is wrong, in a sentence

level: Option<FindingLevel>

overrides the registry’s default level for the id

pos: Option<SourcePos>

where in the document, if anywhere

hint: Option<String>

the nearest description: in scope

Implementations

impl FindingSpec

pub fn new(id: impl Into<String>, message: impl Into<String>) -> Self

A spec with an id and a message, and no level, position or hint.

pub fn level(self, level: FindingLevel) -> Self

Override the registry default level.

pub fn pos(self, pos: SourcePos) -> Self

Pin the finding to a source position (omit for whole-document absence findings).

pub fn hint_opt(self, hint: Option<&str>) -> Self

Attach the nearest enclosing description: as the finding’s hint. None leaves the slot absent.

Trait Implementations

impl Clone for FindingSpec

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 FindingSpec

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

Formats the value using the given formatter.