Struct Rule 

pub struct Rule {

    pub identifier: String,
    pub license_expression: String,
    pub text: String,
    pub tokens: Vec<TokenId>,
    pub rule_kind: RuleKind,
    pub is_false_positive: bool,
    pub is_required_phrase: bool,
    pub is_from_license: bool,
    pub relevance: u8,
    pub minimum_coverage: Option<u8>,
    pub has_stored_minimum_coverage: bool,
    pub is_continuous: bool,
    pub required_phrase_spans: Vec<Range<usize>>,
    pub stopwords_by_pos: HashMap<usize, usize>,
    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 length_unique: usize,
    pub high_length_unique: usize,
    pub high_length: usize,
    pub min_matched_length: usize,
    pub min_high_matched_length: usize,
    pub min_matched_length_unique: usize,
    pub min_high_matched_length_unique: usize,
    pub is_small: bool,
    pub is_tiny: bool,
    pub starts_with_license: bool,
    pub ends_with_license: bool,
    pub is_deprecated: bool,
    pub spdx_license_key: Option<String>,
    pub other_spdx_license_keys: Vec<String>,
}

Rule metadata loaded from .LICENSE and .RULE files.

Fields

identifier: String

Unique identifier for this rule (e.g., “mit.LICENSE”, “gpl-2.0_12.RULE”) Used for sorting to match Python’s attr.s field order. This is the primary sort key after rid (which is None at sort time in Python).

license_expression: String

License expression string using SPDX syntax and ScanCode license keys

text: String

Pattern text to match

tokens: Vec<TokenId>

Token IDs for the text (assigned during indexing)

rule_kind: RuleKind

Classification of this rule.

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. A required phrase is an essential section of the rule text which must be present in the case of partial matches.

is_from_license: bool

True if this rule was created from a license file (not a .RULE file)

relevance: u8

Relevance score 0-100 (100 is most relevant)

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

required_phrase_spans: Vec<Range<usize>>

Token position spans for required phrases parsed from {{…}} markers. Each span represents positions in the rule text that MUST be matched.

stopwords_by_pos: HashMap<usize, usize>

Mapping from token position to count of stopwords at that position. Used for required phrase validation.

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

length_unique: usize

Count of unique token IDs in the rule (computed during indexing)

high_length_unique: usize

Count of unique legalese token IDs (tokens with ID < len_legalese)

high_length: usize

Total count of legalese token occurrences (with duplicates)

min_matched_length: usize

Minimum matched length threshold (occurrences-based)

min_high_matched_length: usize

Minimum high-value token matched length threshold (occurrences-based)

min_matched_length_unique: usize

Minimum matched length threshold (unique tokens)

min_high_matched_length_unique: usize

Minimum high-value token matched length threshold (unique tokens)

is_small: bool

True if rule length < SMALL_RULE (15 tokens)

is_tiny: bool

True if rule length < TINY_RULE (6 tokens)

starts_with_license: bool

True if the rule’s first token is “license”, “licence”, or “licensed”

ends_with_license: bool

True if the rule’s last token is “license”, “licence”, or “licensed”

is_deprecated: bool

Whether this rule is deprecated

spdx_license_key: Option<String>

SPDX license identifier if available

other_spdx_license_keys: Vec<String>

Alternative SPDX license identifiers (aliases)

Implementations

impl Rule

pub const fn kind(&self) -> RuleKind

pub const fn is_license_text(&self) -> bool

pub const fn is_license_notice(&self) -> bool

Returns true if this rule is a license notice pattern.

Note: This method is kept for API completeness and potential future use. License matches cannot have is_license_notice - only rules can.

pub const fn is_license_reference(&self) -> bool

pub const fn is_license_tag(&self) -> bool

pub const fn is_license_intro(&self) -> bool

Returns true if this rule is a license introduction pattern.

Note: This method is kept for API completeness and potential future use.

pub const fn is_license_clue(&self) -> bool

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.

impl Ord for Rule

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Rule

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Rule

impl StructuralPartialEq for Rule