Struct RuleMatch

pub struct RuleMatch {
    pub rule_index: usize,
    pub path: Path<'static>,
    pub replacement_type: ReplacementType,
    pub start_index: usize,
    pub end_index_exclusive: usize,
    pub shift_offset: isize,
    pub match_value: Option<String>,
    pub match_status: MatchStatus,
}

Metadata about a rule match.

Fields

rule_index: usize

The index of the rule that matched. This preserves the order of rules that were passed into the scanner.

path: Path<'static>

The path where the match occurred

replacement_type: ReplacementType

The type of replacement that happened

start_index: usize

The start of the match. This points to the replaced text, and not the original text. The index is based off of the encoding for the event.

end_index_exclusive: usize

The end, exclusive of the match. This points to the replaced text, and not the original text. The index is based off of the encoding for the event.

shift_offset: isize

the difference between the end (UTF8 byte index) of the match data in the INPUT string and the end (UTF8 byte index) of the match data applied to the new OUTPUT string after match actions performed.

match_value: Option<String>

match_status: MatchStatus

Trait Implementations

impl Debug for RuleMatch

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

Formats the value using the given formatter.

impl Ord for RuleMatch

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

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

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

impl StructuralPartialEq for RuleMatch