Struct Violation 

pub struct Violation {
    pub code: ViolationCode,
    pub severity: Severity,
    pub rule: String,
    pub path: String,
    pub line: Option<usize>,
    pub symbol: String,
    pub message: String,
    pub why: String,
    pub remediation: String,
}

One finding: what, where, why, and what to do.

Fields

code: ViolationCode

The stable code.

severity: Severity

How bad it is.

rule: String

The canonical id of the rule that requires this.

path: String

Where it is, repository-relative; empty when the finding is not about a file.

line: Option<usize>

The line, 1-based; None when the finding is not about a line.

symbol: String

The item’s full path, or the command, or the capability id: what the finding is about.

message: String

One sentence, specific to this occurrence.

why: String

Why it matters, from the code.

remediation: String

What to do, from the code.

Implementations

impl Violation

pub fn new( code: ViolationCode, symbol: impl Into<String>, path: impl Into<String>, line: Option<usize>, message: impl Into<String>, ) -> Self

A finding about an item at a place.

The why and the remediation come from the code rather than from the caller, so that two findings of one kind cannot explain themselves differently.

use majordomus_cli::quality::{Violation, ViolationCode};
let v = Violation::new(
    ViolationCode::RustModuleMissingExample,
    "majordomus_cli::graph",
    "apps/majordomus-cli/src/graph.rs",
    Some(1),
    "the module header carries no executable example",
);
assert_eq!(v.rule, "project.rust-public-api-quality@1");
assert!(v.remediation.contains("//!"));

pub fn line_summary(&self) -> String

The finding as one line, the way the terminal and a CI annotation show it.

use majordomus_cli::quality::{Violation, ViolationCode};
let v = Violation::new(
    ViolationCode::RustPublicMissingExample,
    "majordomus_cli::graph::build",
    "apps/majordomus-cli/src/graph.rs",
    Some(42),
    "carries behaviour and no executable example",
);
assert_eq!(
    v.line_summary(),
    "apps/majordomus-cli/src/graph.rs:42: RUST_PUBLIC_MISSING_EXAMPLE majordomus_cli::graph::build — carries behaviour and no executable example"
);

Trait Implementations

impl Clone for Violation

fn clone(&self) -> Violation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Violation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Violation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Violation

impl JsonSchema for Violation

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Violation

fn eq(&self, other: &Violation) -> 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 Violation

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 Violation