Struct OverlappingState

pub struct OverlappingState { /* private fields */ }

Represents the current state of an overlapping search.

This is used for overlapping searches since they need to know something about the previous search. For example, when multiple patterns match at the same position, this state tracks the last reported pattern so that the next search knows whether to report another matching pattern or continue with the search at the next position. Additionally, it also tracks which state the last search call terminated in.

This type provides little introspection capabilities. The only thing a caller can do is construct it and pass it around to permit search routines to use it to track state, and also ask whether a match has been found.

Callers should always provide a fresh state constructed via OverlappingState::start when starting a new search. Reusing state from a previous search may result in incorrect results.

Implementations

impl OverlappingState

pub fn start() -> OverlappingState

Create a new overlapping state that begins at the start state of any automaton.

pub fn get_match(&self) -> Option<HalfMatch>

Return the match result of the most recent search to execute with this state.

A searches will clear this result automatically, such that if no match is found, this will correctly report None.

Trait Implementations

impl Clone for OverlappingState

fn clone(&self) -> OverlappingState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OverlappingState

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

Formats the value using the given formatter.

impl PartialEq for OverlappingState

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

impl StructuralPartialEq for OverlappingState