Struct CustomRule 

pub struct CustomRule {
    pub id: String,
    pub name: String,
    pub description: String,
    pub severity: Severity,
    pub category: FindingCategory,
    pub match_spec: MatchSpec,
    pub source_file: Option<PathBuf>,
}

A user-defined rule loaded from YAML. Fires when source, sink, and path predicates all match a propagation path produced by the engine.

Fields

id: String

Stable identifier, embedded into every emitted finding’s message and extracted by SARIF / JSON sinks via extract_custom_rule_id. Validated at deserialise time against ^[A-Za-z_][A-Za-z0-9_-]{0,63}$ so a malicious or sloppy YAML cannot inject ]/[/whitespace and corrupt the message-encoding contract or empty out the rule attribution.

name: String

description: String

severity: Severity

category: FindingCategory

match_spec: MatchSpec

source_file: Option<PathBuf>

Path of the YAML file this rule was loaded from. Set by load_rules_dir / parse_rules_multi_doc_with_source. Threaded into every Finding this rule emits (FindingSource::Custom) so an operator inspecting JSON / SARIF output can distinguish authentic built-in findings from any rule that may have been planted in a shared --invariants-dir. Defaults to None for rules constructed in tests or in code paths that didn’t go through the loader.

Trait Implementations

impl Clone for CustomRule

fn clone(&self) -> CustomRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomRule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CustomRule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.