Struct Finding 

pub struct Finding {
    pub gate: String,
    pub severity: Severity,
    pub code: Option<String>,
    pub message: String,
    pub path: Option<String>,
}

A single audit finding produced by a gate.

Fields

gate: String

Identifier of the gate that produced the finding (e.g. "wcag", "hreflang").

severity: Severity

Severity of the finding.

code: Option<String>

Optional rule code ("WCAG-1.1.1", "OG-MISSING", …) for downstream tooling to group by.

message: String

Human-readable message.

path: Option<String>

Path the finding was raised against, relative to the site root. None for site-wide findings (e.g. a missing manifest file).

Implementations

impl Finding

pub fn new( gate: impl Into<String>, severity: Severity, message: impl Into<String>, ) -> Self

Convenience constructor for a path-scoped finding.

Examples

use ssg::audit::{Finding, Severity};
let f = Finding::new("wcag", Severity::Warn, "missing alt text");
assert_eq!(f.gate, "wcag");
assert_eq!(f.severity, Severity::Warn);
assert_eq!(f.message, "missing alt text");
assert!(f.code.is_none());

pub fn with_code(self, code: impl Into<String>) -> Self

Builder: attaches a rule code.

Examples

use ssg::audit::{Finding, Severity};
let f = Finding::new("wcag", Severity::Warn, "missing alt").with_code("WCAG-1.1.1");
assert_eq!(f.code.as_deref(), Some("WCAG-1.1.1"));

pub fn with_path(self, path: impl Into<String>) -> Self

Builder: attaches a path.

Examples

use ssg::audit::{Finding, Severity};
let f = Finding::new("links", Severity::Error, "broken").with_path("blog/foo.html");
assert_eq!(f.path.as_deref(), Some("blog/foo.html"));

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<'de> Deserialize<'de> for Finding

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Finding

impl PartialEq for Finding

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Finding

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Finding