Struct RuleCard 

pub struct RuleCard {
    pub message: String,
    pub remediation: String,
    pub examples: Examples,
}

Everything a reader — human or model — needs to act on a violation.

Fields

message: String

One line saying what is wrong. Not what to do about it.

remediation: String

What to do instead. Specific enough to act on without reading the rule source.

examples: Examples

A bad/good pair.

Implementations

impl RuleCard

pub fn validate(&self) -> Result<(), Vec<CardProblem>>

Check that the card can actually do its job.

This is deliberately more than a null check. A card is the tool’s output, and an empty remediation produces a violation a reader cannot act on — which is indistinguishable, from their side, from lanekeep being wrong.

Errors

Returns every problem found, so a rule author fixes them in one pass rather than one per run.

Trait Implementations

impl Clone for RuleCard

fn clone(&self) -> RuleCard

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuleCard

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RuleCard

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RuleCard

impl PartialEq for RuleCard

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RuleCard

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 RuleCard