Struct LoadedRule 

pub struct LoadedRule {

    pub identifier: String,
    pub license_expression: String,
    pub text: String,
    pub rule_kind: RuleKind,
    pub is_false_positive: bool,
    pub is_required_phrase: bool,
    pub relevance: Option<u8>,
    pub minimum_coverage: Option<u8>,
    pub has_stored_minimum_coverage: bool,
    pub is_continuous: bool,
    pub referenced_filenames: Option<Vec<String>>,
    pub ignorable_urls: Option<Vec<String>>,
    pub ignorable_emails: Option<Vec<String>>,
    pub ignorable_copyrights: Option<Vec<String>>,
    pub ignorable_holders: Option<Vec<String>>,
    pub ignorable_authors: Option<Vec<String>>,
    pub language: Option<String>,
    pub notes: Option<String>,
    pub is_deprecated: bool,
}

Loader-stage representation of a rule.

This struct contains parsed and normalized data from a .RULE or .LICENSE file. It is serialized at build time and deserialized at runtime, then converted to a runtime Rule during the build stage.

Fields

identifier: String

Unique identifier derived from the filename (e.g., “mit.LICENSE”).

license_expression: String

License expression string using SPDX syntax and ScanCode license keys. For false-positive rules with no source expression, this is set to “unknown”.

text: String

Pattern text to match, trimmed and normalized.

rule_kind: RuleKind

Classification of this rule, derived from source rule-kind booleans.

is_false_positive: bool

True if exact matches to this rule are false positives.

is_required_phrase: bool

True if this rule text is a required phrase.

relevance: Option<u8>

Relevance score 0-100 (100 is most relevant). Stored as Option to distinguish between explicit 100 and default 100.

minimum_coverage: Option<u8>

Minimum match coverage percentage (0-100) if specified.

has_stored_minimum_coverage: bool

True if minimum_coverage was explicitly stored in source frontmatter.

is_continuous: bool

Tokens must appear in order if true.

referenced_filenames: Option<Vec<String>>

Filenames where this rule should be considered.

ignorable_urls: Option<Vec<String>>

URLs that should be ignored when found in this rule text.

ignorable_emails: Option<Vec<String>>

Emails that should be ignored when found in this rule text.

ignorable_copyrights: Option<Vec<String>>

Copyrights that should be ignored when found in this rule text.

ignorable_holders: Option<Vec<String>>

Holder names that should be ignored when found in this rule text.

ignorable_authors: Option<Vec<String>>

Author names that should be ignored when found in this rule text.

language: Option<String>

Programming language for the rule if specified.

notes: Option<String>

Free text notes.

is_deprecated: bool

Whether this rule is deprecated.

Implementations

impl LoadedRule

Loader-stage normalization functions for rule data.

pub fn derive_identifier(filename: &str) -> String

Derive identifier from filename.

Returns the filename as-is, which serves as the unique identifier.

pub fn derive_rule_kind( is_license_text: bool, is_license_notice: bool, is_license_reference: bool, is_license_tag: bool, is_license_intro: bool, is_license_clue: bool, ) -> Result<RuleKind, RuleKindError>

Derive rule kind from source rule-kind booleans.

Returns an error if multiple flags are set.

pub fn normalize_license_expression( expression: Option<&str>, is_false_positive: bool, ) -> Result<String, LicenseExpressionError>

Normalize license expression.

• Strips trivial outer parentheses
• For false-positive rules with no expression, returns “unknown”
• For non-false-positive rules with no expression, returns an error

pub fn normalize_optional_string(s: Option<&str>) -> Option<String>

Normalize optional string field.

Returns None for empty strings, Some(trimmed) otherwise.

pub fn normalize_optional_list(list: Option<&[String]>) -> Option<Vec<String>>

Normalize optional string list.

Returns None for empty lists, Some(list) with trimmed strings otherwise.

pub fn validate_rule_kind_flags( rule_kind: RuleKind, is_false_positive: bool, ) -> Result<(), RuleKindError>

Validate rule-kind flags against false_positive flag.

• False-positive rules must NOT have any is_license_* flags set
• Non-false-positive rules MUST have exactly one is_license_* flag set

Trait Implementations

impl Clone for LoadedRule

fn clone(&self) -> LoadedRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LoadedRule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LoadedRule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for LoadedRule

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for LoadedRule

impl StructuralPartialEq for LoadedRule