Struct RuleReport 

#[non_exhaustive]
pub struct RuleReport {
    pub spec: RuleSpec,
    pub layer: String,
    pub other: Option<String>,
    pub counts: BTreeMap<ViolationKind, usize>,
    pub violations: Vec<Violation>,
}

One rule’s violations, with deterministic counts and feature provenance.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

spec: RuleSpec

Registered rule with its topology-scoped rule and layer IDs.

layer: String

Primary input layer name.

other: Option<String>

Secondary input layer name for a binary rule.

counts: BTreeMap<ViolationKind, usize>

Number of aggregated violations per kind, in kind order.

violations: Vec<Violation>

Deterministically ordered violations, serialized as errors. Several parts may contribute to one violation.

Implementations

impl RuleReport

pub fn layer_name(&self, id: LayerId) -> Option<&str>

Return the name of one of this rule’s input layers, as referenced by its violations.

Trait Implementations

impl Clone for RuleReport

fn clone(&self) -> RuleReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuleReport

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

Formats the value using the given formatter.

impl Serialize for RuleReport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.