Struct PositionedMatch 

#[non_exhaustive]
pub struct PositionedMatch {
    pub start: usize,
    pub end: usize,
    pub pattern_index: usize,
}

Where one match lies in the searched text: byte offsets plus the index of the pattern that matched.

Produced by CompiledMatcher::find_positions and CompiledMatcher::push_positions. It is Copy and borrows nothing, so producing it never allocates. pattern_index is the pattern’s insertion position, as used by CompiledMatcher::patterns, CompiledMatcher::pattern and CompiledMatcher::term.

The derived ordering compares start, then end, then pattern_index: the order in which MatchOverlap::All results are reported.

Marked #[non_exhaustive] so fields can be added in a minor release; read the public fields directly.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

start: usize

Byte offset of the first byte of the match (on a char boundary).

end: usize

Byte offset one past the last byte of the match (on a char boundary).

pattern_index: usize

Insertion index of the pattern that matched.

Implementations

impl PositionedMatch

pub const fn new(start: usize, end: usize, pattern_index: usize) -> Self

Build a position, for example as an expected value in a test.

use terraphim_automata::PositionedMatch;

let m = PositionedMatch::new(3, 7, 0);
assert_eq!((m.start, m.end, m.pattern_index), (3, 7, 0));

pub const fn range(&self) -> Range<usize>

The matched byte range, start..end.

Trait Implementations

impl Clone for PositionedMatch

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PositionedMatch

impl Debug for PositionedMatch

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

Formats the value using the given formatter.

impl Eq for PositionedMatch

impl From<Match> for PositionedMatch

fn from(mat: Match) -> Self

Converts to this type from the input type.

impl Hash for PositionedMatch

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PositionedMatch

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for PositionedMatch

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PositionedMatch

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 StructuralPartialEq for PositionedMatch